allure 3.21.0 → 3.22.1

package/README.md

@@ -139,6 +139,23 @@ npx allure agent query --latest tests --status failed
 npx allure agent query --from ./agent-output findings --severity high
 ```
 
+### Generating GitHub Actions Jobs
+
+Print GitHub Actions jobs that run your tests once per environment and build a single Allure report from all of them:
+
+```bash
+npx allure gh-workflow --env foo --env bar --env baz -- npm test
+```
+
+Paste the output under `jobs:` in a workflow file and fill in the `TODO` steps (runtime setup and dependencies). The output has two jobs:
+
+- `test` runs `allure run --environment=<id> --dump=allure-results-<id> -- <test command>` for every environment in a matrix and uploads `allure-results-<id>.zip` as an artifact;
+- `report` downloads all `allure-results-*` artifacts and runs `allure generate --dump="allure-results-*/*.zip"`.
+
+The environment id, the dump file, the artifact name and the download pattern have to agree with each other; the command keeps them consistent.
+
+Environments come from `--env` (repeatable, no config needed). Without `--env`, the ids declared under `environments` in your Allure config are used (integer-like ids come first, as JavaScript orders object keys). Pass the test command after `--` (default: `npm test`); `--config` is also added to the generated `allure` commands. The versions of the GitHub actions in the output are examples, pin the ones you use. Errors are written to stderr with a non-zero exit code, while command-line syntax errors are reported by the CLI parser on stdout.
+
 ### Generating Reports Manually
 
 If you already have test results and wish to generate a report manually, use the `generate` command:
@@ -165,6 +182,26 @@ npx allure open allure-report/awesome
 
 If the provided directory doesn't contain previously generated report, it will be treated as a source of results, and a new report will be generated on the fly and opened in the browser.
 
+To stop serving the report, press CTRL+C.
+
+#### Serving a report without opening
+
+Use the `serve` command to start a local report server without opening a browser:
+
+```bash
+npx allure serve <reportDir>
+```
+
+Like `open`, this command uses the configured output directory when `<reportDir>` is omitted and generates a report on the fly when given test results. Open the URL printed in the console to view the report.
+
+Use `--host` and `--port` to control the interfaces and port to listen:
+
+```bash
+npx allure serve --port 8080 --host 127.0.0.1
+```
+
+Press CTRL+C to stop serving.
+
 ### Real-time Report Monitoring
 
 When you need to monitor test execution live, the `watch` command provides dynamic report updates. It continuously monitors the specified results directory for changes and refreshes the report automatically:
@@ -205,7 +242,7 @@ tag. Unrecognized version formats are silently skipped.
 Allure 3 uses an `allurerc.ts`, `allurerc.mts`, `allurerc.cts`, `allurerc.mjs`, or `allurerc.js` configuration file to manage report settings, including the report name, output directory, and plugin options.
 
 > [!TIP]
-> We recommend using the **Awesome** plugin for the best experience.  
+> We recommend using the **Awesome** plugin for the best experience.
 > Support for Classic and Allure 2-style reports is currently experimental.
 
 ### Example Configuration File
@@ -272,7 +309,7 @@ For example, setting `"reportLanguage": "fr"` will render the report interface i
 
 You can also use `allurerc.json`, `allurerc.yaml`, or `allurerc.yml` files as a declarative way to configure Allure 3.
 
-> [!WARNING]  
+> [!WARNING]
 > Declarative formats don't support advanced features such as tests filtering or environments.
 > If you need these features, please consider using the `allurerc.ts`, `allurerc.mts`, `allurerc.cts`, `allurerc.mjs`, or `allurerc.js` files.
 

package/dist/commands/ghWorkflow.d.ts

@@ -0,0 +1,11 @@
+import { Command } from "clipanion";
+export declare class GhWorkflowCommand extends Command {
+    #private;
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    environments: string[] | undefined;
+    config: string | undefined;
+    cwd: string | undefined;
+    testCommand: string[];
+    execute(): Promise<0 | 1>;
+}

package/dist/commands/ghWorkflow.js

@@ -0,0 +1,77 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _GhWorkflowCommand_instances, _GhWorkflowCommand_readConfiguredEnvironmentIds;
+import { realpath } from "node:fs/promises";
+import process from "node:process";
+import { readConfig } from "@allurereport/core";
+import { Command, Option, UsageError } from "clipanion";
+import { buildGhWorkflowYaml, configuredEnvironmentIds, normalizeEnvironmentIds } from "../utils/ghWorkflow.js";
+const describeError = (error) => {
+    if (error instanceof UsageError) {
+        return error.message;
+    }
+    return error instanceof Error ? (error.stack ?? error.message) : String(error);
+};
+export class GhWorkflowCommand extends Command {
+    constructor() {
+        super(...arguments);
+        _GhWorkflowCommand_instances.add(this);
+        this.environments = Option.Array("--environment,--env", {
+            description: "Environment id to include. Can be repeated. Default: every environment from the config",
+        });
+        this.config = Option.String("--config,-c", {
+            description: "The path to Allure config file. Also passed to the generated allure commands",
+        });
+        this.cwd = Option.String("--cwd", {
+            description: "The working directory for the command to run (default: current working directory)",
+        });
+        this.testCommand = Option.Rest({
+            name: "Test command to run. Pass it after `--` (default: npm test)",
+        });
+    }
+    async execute() {
+        try {
+            const environmentIds = this.environments !== undefined && this.environments.length > 0
+                ? normalizeEnvironmentIds(this.environments)
+                : await __classPrivateFieldGet(this, _GhWorkflowCommand_instances, "m", _GhWorkflowCommand_readConfiguredEnvironmentIds).call(this);
+            const yaml = buildGhWorkflowYaml({
+                environmentIds,
+                testCommand: this.testCommand.length > 0 ? this.testCommand : undefined,
+                config: this.config,
+            });
+            this.context.stdout.write(yaml);
+            return 0;
+        }
+        catch (error) {
+            this.context.stderr.write(`${describeError(error)}\n`);
+            return 1;
+        }
+    }
+}
+_GhWorkflowCommand_instances = new WeakSet(), _GhWorkflowCommand_readConfiguredEnvironmentIds = async function _GhWorkflowCommand_readConfiguredEnvironmentIds() {
+    const cwd = await realpath(this.cwd ?? process.cwd());
+    const config = await readConfig(cwd, this.config, { plugins: {} });
+    return configuredEnvironmentIds(config.environments);
+};
+GhWorkflowCommand.paths = [["gh-workflow"]];
+GhWorkflowCommand.usage = Command.Usage({
+    category: "Integrations",
+    description: "Prints GitHub Actions jobs that run tests per environment and build one Allure report",
+    details: `
+      Prints a \`test\` job (a matrix over the environments: \`allure run\` with a dump, then the dump is uploaded)
+      and a \`report\` job (downloads all dumps and runs \`allure generate\`). Paste the output under \`jobs:\` of a
+      workflow file and fill in the TODO steps. The names of the environment, the dump file, the artifact and the
+      download pattern are kept consistent for you.
+      Environments come from \`--env\`; without it, the \`environments\` declared in the Allure config are used.
+      Errors are written to stderr and the exit code is non-zero. Command-line syntax errors are reported by the CLI
+      parser on stdout. Versions of the GitHub actions in the output are examples, pin the ones you use.
+    `,
+    examples: [
+        ["gh-workflow --env foo --env bar --env baz", "Print the jobs for three environments (test command: npm test)"],
+        ["gh-workflow --env linux --env windows -- yarn test", "Use a custom test command"],
+        ["gh-workflow --config ./allurerc.mjs", "Use the environments declared in the config"],
+    ],
+});

package/dist/commands/index.d.ts

@@ -16,8 +16,10 @@ export * from "./open.js";
 export * from "./qualityGate.js";
 export * from "./log.js";
 export * from "./generate.js";
+export * from "./ghWorkflow.js";
 export * from "./dashboard.js";
 export * from "./results/index.js";
 export * from "./jira/index.js";
 export * from "./gitlab/index.js";
 export * from "./migrate.js";
+export * from "./serve.js";

package/dist/commands/index.js

@@ -16,8 +16,10 @@ export * from "./open.js";
 export * from "./qualityGate.js";
 export * from "./log.js";
 export * from "./generate.js";
+export * from "./ghWorkflow.js";
 export * from "./dashboard.js";
 export * from "./results/index.js";
 export * from "./jira/index.js";
 export * from "./gitlab/index.js";
 export * from "./migrate.js";
+export * from "./serve.js";

package/dist/commands/jira/clear.js

@@ -63,7 +63,7 @@ export class JiraClearCommand extends BaseJiraCommand {
                 await jiraPlugin.clearAll(this.issues);
                 this.context.stdout.write(green("All reports and test results have been unlinked from the specified Jira issue"));
             }
-            catch (error) {
+            catch {
                 this.context.stderr.write(red("Failed to unlink reports and test results from the specified Jira issue"));
                 exit(1);
             }
@@ -73,7 +73,7 @@ export class JiraClearCommand extends BaseJiraCommand {
                 await jiraPlugin.clearReports(this.issues);
                 this.context.stdout.write(green("All reports have been unlinked from the specified Jira issue"));
             }
-            catch (error) {
+            catch {
                 this.context.stderr.write(red("Failed to unlink reports from the specified Jira issue"));
                 exit(1);
             }
@@ -83,7 +83,7 @@ export class JiraClearCommand extends BaseJiraCommand {
                 await jiraPlugin.clearResults(this.issues);
                 this.context.stdout.write(green("All test results have been unlinked from the specified Jira issue"));
             }
-            catch (error) {
+            catch {
                 this.context.stderr.write(red("Failed to unlink test results from the specified Jira issue"));
                 exit(1);
             }

package/dist/commands/open.d.ts

@@ -1,14 +1,6 @@
-import { Command } from "clipanion";
-export declare class OpenCommand extends Command {
+import { BaseServeCommand } from "./serve.js";
+export declare class OpenCommand extends BaseServeCommand {
     static paths: string[][];
     static usage: import("clipanion").Usage;
-    resultsDir: string[];
-    config: string | undefined;
-    port: string | undefined;
-    host: string | undefined;
-    cwd: string | undefined;
-    hideLabels: string[] | undefined;
-    execute(): Promise<void>;
-    private resolveReportPath;
-    private reportExists;
+    protected get shouldOpen(): boolean;
 }

package/dist/commands/open.js

@@ -1,120 +1,31 @@
-import { existsSync } from "node:fs";
-import { mkdtemp, rm } from "node:fs/promises";
-import { tmpdir } from "node:os";
-import { join, resolve } from "node:path";
-import { cwd as processCwd, exit } from "node:process";
-import { readConfig } from "@allurereport/core";
-import { serve } from "@allurereport/static-server";
-import { Command, Option } from "clipanion";
-import { red } from "yoctocolors";
-import { findFilesByGlobs } from "./../utils/fileSystem.js";
-import { resolveResultsPatterns } from "./../utils/resultsPatterns.js";
-import { serverOptionsFromConfig } from "./../utils/serverOptions.js";
-import { notifySignals, waitForAbort } from "./../utils/signals.js";
-import { generate } from "./commons/generate.js";
-export class OpenCommand extends Command {
-    constructor() {
-        super(...arguments);
-        this.resultsDir = Option.Rest({
-            name: "A report path to open, or results patterns. Overrides config.resultsDir. Empty Rest serves the configured output.",
-        });
-        this.config = Option.String("--config,-c", {
-            description: "The path to Allure config file",
-        });
-        this.port = Option.String("--port", {
-            description: "The port to serve the reports on. If not set, the server starts on a random port",
-        });
-        this.host = Option.String("--host", {
-            description: "The host (network interface) to serve the reports on, e.g. 127.0.0.1 or 0.0.0.0 (default: all interfaces)",
-        });
-        this.cwd = Option.String("--cwd", {
-            description: "The working directory for the command to run (default: current working directory)",
-        });
-        this.hideLabels = Option.Array("--hide-labels", {
-            description: "Hide labels by exact name in generated reports. Repeat the option for multiple labels",
-        });
-    }
-    async execute() {
-        const cwd = this.cwd ?? processCwd();
-        const hideLabels = this.hideLabels?.length ? this.hideLabels : undefined;
-        const config = await readConfig(cwd, this.config, {
-            port: this.port,
-            host: this.host,
-        });
-        const servePath = this.resolveReportPath(cwd, this.resultsDir, config.output);
-        const resolvedPatterns = resolveResultsPatterns(this.resultsDir, config.resultsDir);
-        if (await this.reportExists(servePath)) {
-            await serve({
-                ...serverOptionsFromConfig(config),
-                servePath,
-                open: true,
-            });
-        }
-        else if (resolvedPatterns.length) {
-            const tmpDir = await mkdtemp(join(tmpdir(), "allure-report-"));
-            const config = await readConfig(cwd, this.config, {
-                port: this.port,
-                host: this.host,
-                output: tmpDir,
-                hideLabels,
-            });
-            await generate({
-                resultsDir: this.resultsDir,
-                cwd,
-                config,
-            });
-            const notifier = notifySignals(["SIGINT", "SIGTERM"]);
-            void waitForAbort(notifier.signal).then(async () => {
-                try {
-                    await rm(config.output, { recursive: true });
-                }
-                catch { }
-                process.exit(notifier.info()?.code ?? 0);
-            });
-            await serve({
-                ...serverOptionsFromConfig(config),
-                servePath: config.output,
-                open: true,
-            });
-        }
-        else {
-            console.error(red(`A report doesn't exist in ${servePath} and no input was provided to generate.`));
-            exit(1);
-            return;
-        }
-    }
-    resolveReportPath(cwd, inputs, fallback = "allure-report") {
-        if (inputs.length <= 1) {
-            const [maybeRelativeReportPath = fallback] = inputs;
-            return resolve(cwd, maybeRelativeReportPath);
-        }
-    }
-    async reportExists(reportPath) {
-        if (reportPath && existsSync(reportPath)) {
-            const summaryFiles = await findFilesByGlobs(reportPath, [join("**", "summary.json")]);
-            return summaryFiles.length > 0;
-        }
-        return false;
+import { Command } from "clipanion";
+import { BaseServeCommand } from "./serve.js";
+export class OpenCommand extends BaseServeCommand {
+    get shouldOpen() {
+        return true;
     }
 }
-OpenCommand.paths = [["open"], ["serve"]];
+OpenCommand.paths = [["open"]];
 OpenCommand.usage = Command.Usage({
-    description: "Serves specified directory",
-    details: "This command generates report with the given test results and opens it in the default browser.",
+    description: "Serves a report and opens it in the default browser, generating it from test results if necessary.",
+    details: "This command starts a report server and opens the report in the default browser. If test results are" +
+        " provided, it generates the report in a temporary directory before serving and opening it. With no arguments," +
+        " it serves the configured output directory or, if no report exists there, generates a report from the" +
+        " configured test results.",
     examples: [
-        ["open ./allure-results", "Generate and serve the report based on given test results directory"],
-        ["open --port 8080 ./allure-report", "Serve the report on port 8080"],
+        ["open ./allure-results", "Generate, serve, and open the report from the given test results directory"],
+        ["open --port 8080 ./allure-report", "Serve the report on port 8080 and open it"],
         [
-            "open --host 0.0.0.0 ./allure-report",
-            "Serve the report on all network interfaces, so it is reachable remotely",
+            "open --host 127.0.0.1 ./allure-report",
+            "Serve the report on the loopback interface only and open it in the default browser.",
         ],
         [
             "open ./packages/*/allure-results",
-            "Generate and serve the report from all Allure result directories matching the pattern",
+            "Generate, serve, and open the report from all test results directories matching the pattern",
         ],
         [
-            "open ./packages/foo/allure-results /packages/bar/allure-results",
-            "Generate and serve the report from two Allure result directories",
+            "open ./packages/foo/allure-results ./packages/bar/allure-results",
+            "Generate, serve, and open the report from two test results directories",
         ],
     ],
 });

package/dist/commands/serve.d.ts

@@ -0,0 +1,19 @@
+import { Command } from "clipanion";
+export declare abstract class BaseServeCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    resultsDir: string[];
+    config: string | undefined;
+    port: string | undefined;
+    host: string | undefined;
+    cwd: string | undefined;
+    hideLabels: string[] | undefined;
+    protected abstract get shouldOpen(): boolean;
+    execute(): Promise<number>;
+    private resolveReportPath;
+    private reportExists;
+}
+export declare class ServeCommand extends BaseServeCommand {
+    open: boolean | undefined;
+    protected get shouldOpen(): boolean;
+}

package/dist/commands/serve.js

@@ -0,0 +1,168 @@
+import { existsSync } from "node:fs";
+import { mkdtemp, rm } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join, resolve } from "node:path";
+import { cwd as processCwd, exit } from "node:process";
+import { readConfig } from "@allurereport/core";
+import { serve } from "@allurereport/static-server";
+import { Command, Option } from "clipanion";
+import { red } from "yoctocolors";
+import { findFilesByGlobs } from "./../utils/fileSystem.js";
+import { resolveResultsPatterns } from "./../utils/resultsPatterns.js";
+import { serverOptionsFromConfig } from "./../utils/serverOptions.js";
+import { notifySignals, waitForAbort } from "./../utils/signals.js";
+import { generate } from "./commons/generate.js";
+const ESCALATION_DELAY = 3000;
+export class BaseServeCommand extends Command {
+    constructor() {
+        super(...arguments);
+        this.resultsDir = Option.Rest({
+            name: "A report path to open, or results patterns. Overrides config.resultsDir. " +
+                "Empty Rest serves the configured output.",
+        });
+        this.config = Option.String("--config,-c", {
+            description: "Path to Allure configuration file",
+        });
+        this.port = Option.String("--port", {
+            description: "Port for the report server. Overrides the configured port; otherwise, a random available port is used",
+        });
+        this.host = Option.String("--host", {
+            description: "Host address to bind the report server to, e.g. 127.0.0.1 or 0.0.0.0. " +
+                "Overrides the configured host (default: all interfaces)",
+        });
+        this.cwd = Option.String("--cwd", {
+            description: "Working directory for the command (default: current working directory)",
+        });
+        this.hideLabels = Option.Array("--hide-labels", {
+            description: "Hide labels by exact name in generated reports. Repeat the option for multiple labels",
+        });
+    }
+    async execute() {
+        const cwd = this.cwd ?? processCwd();
+        const hideLabels = this.hideLabels?.length ? this.hideLabels : undefined;
+        const config = await readConfig(cwd, this.config, {
+            port: this.port,
+            host: this.host,
+        });
+        const servePath = this.resolveReportPath(cwd, this.resultsDir, config.output);
+        const resolvedPatterns = resolveResultsPatterns(this.resultsDir, config.resultsDir);
+        const onSignalRepeat = (signal) => {
+            const info = notifier.info();
+            if (signal !== "SIGINT" ||
+                info?.signal !== "SIGINT" ||
+                Date.now() >= (info?.receivedAt ?? 0) + ESCALATION_DELAY) {
+                exit(info?.code ?? 1);
+            }
+        };
+        const notifier = notifySignals(["SIGINT", "SIGTERM"], onSignalRepeat);
+        const signalExitCode = () => {
+            const info = notifier.info();
+            return info?.signal === "SIGINT" ? 0 : (info?.code ?? 0);
+        };
+        let server;
+        let tmpDir;
+        try {
+            if (await this.reportExists(servePath)) {
+                if (notifier.signal.aborted) {
+                    return signalExitCode();
+                }
+                server = await serve({
+                    ...serverOptionsFromConfig(config),
+                    servePath,
+                    open: this.shouldOpen,
+                });
+            }
+            else if (resolvedPatterns.length) {
+                tmpDir = await mkdtemp(join(tmpdir(), "allure-report-"));
+                const config = await readConfig(cwd, this.config, {
+                    port: this.port,
+                    host: this.host,
+                    output: tmpDir,
+                    hideLabels,
+                });
+                if (notifier.signal.aborted) {
+                    return signalExitCode();
+                }
+                await generate({
+                    resultsDir: this.resultsDir,
+                    cwd,
+                    config,
+                });
+                if (notifier.signal.aborted) {
+                    return signalExitCode();
+                }
+                server = await serve({
+                    ...serverOptionsFromConfig(config),
+                    servePath: config.output,
+                    open: this.shouldOpen,
+                });
+            }
+            else {
+                console.error(red(`A report doesn't exist in ${servePath} and no input was provided to generate.`));
+                return 1;
+            }
+            await waitForAbort(notifier.signal);
+            console.info(`Allure is stopping.`);
+        }
+        finally {
+            try {
+                await server?.stop();
+            }
+            catch { }
+            if (tmpDir) {
+                try {
+                    await rm(tmpDir, { recursive: true, force: true });
+                }
+                catch { }
+            }
+            notifier.dispose();
+        }
+        return signalExitCode();
+    }
+    resolveReportPath(cwd, inputs, fallback = "allure-report") {
+        if (inputs.length <= 1) {
+            const [maybeRelativeReportPath = fallback] = inputs;
+            return resolve(cwd, maybeRelativeReportPath);
+        }
+    }
+    async reportExists(reportPath) {
+        if (reportPath && existsSync(reportPath)) {
+            const summaryFiles = await findFilesByGlobs(reportPath, [join("**", "summary.json")]);
+            return summaryFiles.length > 0;
+        }
+        return false;
+    }
+}
+BaseServeCommand.paths = [["serve"]];
+BaseServeCommand.usage = Command.Usage({
+    description: "Serves an existing report or generates and serves a report from test results.",
+    details: "This command starts a report server without opening a browser. If test results are provided, it generates the" +
+        " report in a temporary directory before serving it. With no arguments, it serves the configured output " +
+        "directory or, if no report exists there, generates a report from the configured test results. Use --open " +
+        "to also open the report in the default browser.",
+    examples: [
+        ["serve ./allure-results", "Generate and serve the report from the given test results directory"],
+        ["serve --port 8080 ./allure-report", "Serve the report on port 8080"],
+        ["serve --open ./allure-report", "Serve the report and open it in the default browser"],
+        ["serve --host 127.0.0.1 ./allure-report", "Serve the report on the loopback interface only."],
+        [
+            "serve ./packages/*/allure-results",
+            "Generate and serve the report from all test results directories matching the pattern",
+        ],
+        [
+            "serve ./packages/foo/allure-results ./packages/bar/allure-results",
+            "Generate and serve the report from two test results directories",
+        ],
+    ],
+});
+export class ServeCommand extends BaseServeCommand {
+    constructor() {
+        super(...arguments);
+        this.open = Option.Boolean("--open", {
+            description: "Open the report in the default browser (default: false)",
+        });
+    }
+    get shouldOpen() {
+        return Boolean(this.open);
+    }
+}

package/dist/index.js

@@ -1,7 +1,7 @@
 import { readFileSync } from "node:fs";
 import process, { argv } from "node:process";
 import { Builtins, Cli, UsageError } from "clipanion";
-import { AgentCommand, AGENT_TASK_MAP_HELP, AgentCapabilitiesCommand, AgentInspectCommand, AgentLatestCommand, AgentQueryCommand, AgentSelectCommand, AgentStateDirCommand, Allure2Command, AwesomeCommand, CheckCommand, ClassicCommand, CsvCommand, DashboardCommand, GenerateCommand, GitlabGenerateCommand, HistoryCommand, JiraClearCommand, LogCommand, MigrateCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, SlackCommand, TestOpsPlanCommand, TestPlanCommand, WatchCommand, isAgentTaskMapHelpRequest, } from "./commands/index.js";
+import { AgentCommand, AGENT_TASK_MAP_HELP, AgentCapabilitiesCommand, AgentInspectCommand, AgentLatestCommand, AgentQueryCommand, AgentSelectCommand, AgentStateDirCommand, Allure2Command, AwesomeCommand, CheckCommand, ClassicCommand, CsvCommand, DashboardCommand, GenerateCommand, GhWorkflowCommand, GitlabGenerateCommand, HistoryCommand, JiraClearCommand, LogCommand, MigrateCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, ServeCommand, SlackCommand, TestOpsPlanCommand, TestPlanCommand, WatchCommand, isAgentTaskMapHelpRequest, } from "./commands/index.js";
 import { ALLURE2_MIGRATE_REMINDER, getAllure2Hint } from "./utils/allure2Hints.js";
 import { notifyAboutUpdate, parseUpdateNotifierArgs } from "./utils/updateNotifier.js";
 import { applyVerbosity, extractVerbosityFlags } from "./utils/verbosity.js";
@@ -26,6 +26,7 @@ cli.register(ClassicCommand);
 cli.register(CsvCommand);
 cli.register(DashboardCommand);
 cli.register(GenerateCommand);
+cli.register(GhWorkflowCommand);
 cli.register(HistoryCommand);
 cli.register(JiraClearCommand);
 cli.register(LogCommand);
@@ -33,6 +34,7 @@ cli.register(MigrateCommand);
 cli.register(OpenCommand);
 cli.register(QualityGateCommand);
 cli.register(RunCommand);
+cli.register(ServeCommand);
 cli.register(SlackCommand);
 cli.register(TestOpsPlanCommand);
 cli.register(TestPlanCommand);

package/dist/utils/ghWorkflow.d.ts

@@ -0,0 +1,10 @@
+import type { EnvironmentsConfig } from "@allurereport/core-api";
+export type GhWorkflowOptions = {
+    environmentIds: readonly string[];
+    testCommand?: readonly string[];
+    config?: string;
+};
+export declare const shellQuote: (value: string) => string;
+export declare const normalizeEnvironmentIds: (values: readonly string[]) => string[];
+export declare const configuredEnvironmentIds: (environments: EnvironmentsConfig | undefined) => string[];
+export declare const buildGhWorkflowYaml: ({ environmentIds, testCommand, config, }: GhWorkflowOptions) => string;

package/dist/utils/ghWorkflow.js

@@ -0,0 +1,75 @@
+import { UsageError } from "clipanion";
+import { normalizeCommandEnvironmentOptions } from "./environment.js";
+const SAFE_TOKEN = /^[A-Za-z0-9._/:@=-]+$/;
+const INVISIBLE_CHARS = /[\p{Cc}\p{Cf}\p{Zl}\p{Zp}]/u;
+const CHECKOUT_ACTION = "actions/checkout@v6";
+const UPLOAD_ARTIFACT_ACTION = "actions/upload-artifact@v7";
+const DOWNLOAD_ARTIFACT_ACTION = "actions/download-artifact@v8";
+const DEFAULT_TEST_COMMAND = ["npm", "test"];
+const ENVIRONMENT = "${{ matrix.environment }}";
+const NOT_CANCELLED = "${{ !cancelled() }}";
+export const shellQuote = (value) => SAFE_TOKEN.test(value) && !value.startsWith("=") ? value : `'${value.replace(/'/g, `'\\''`)}'`;
+const assertPrintable = (label, value) => {
+    if (INVISIBLE_CHARS.test(value)) {
+        throw new UsageError(`${label} must not contain control or invisible characters`);
+    }
+    return value;
+};
+export const normalizeEnvironmentIds = (values) => [
+    ...new Set(values.map((value) => normalizeCommandEnvironmentOptions({ environment: value }).environment)),
+];
+export const configuredEnvironmentIds = (environments) => {
+    const ids = Object.keys(environments ?? {});
+    if (ids.length === 0) {
+        throw new UsageError("The Allure config has no environments (or no allurerc file was found). " +
+            "Declare `environments` in the config or pass environment ids with --env");
+    }
+    return ids;
+};
+export const buildGhWorkflowYaml = ({ environmentIds, testCommand = DEFAULT_TEST_COMMAND, config, }) => {
+    if (environmentIds.length === 0) {
+        throw new UsageError("At least one environment is required");
+    }
+    const testCommandLine = testCommand.map((token) => shellQuote(assertPrintable("The test command", token))).join(" ");
+    const configOption = config === undefined ? "" : ` --config=${shellQuote(assertPrintable("--config", config))}`;
+    const matrix = environmentIds.map((id) => JSON.stringify(id)).join(", ");
+    const results = `allure-results-${ENVIRONMENT}`;
+    return `# Generated by "allure gh-workflow". Paste it under "jobs:" and adjust the TODO steps.
+  test:
+    name: Test (${ENVIRONMENT})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        environment: [${matrix}]
+    steps:
+      - uses: ${CHECKOUT_ACTION}
+      # TODO: set up your runtime and install dependencies
+      - name: Test
+        run: |
+          npx allure run${configOption} --environment=${ENVIRONMENT} --dump=${results} -- ${testCommandLine}
+      - name: Upload Allure results
+        if: ${NOT_CANCELLED}
+        uses: ${UPLOAD_ARTIFACT_ACTION}
+        with:
+          name: ${results}
+          path: ./${results}.zip
+
+  report:
+    name: Report
+    needs: [test]
+    if: ${NOT_CANCELLED}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ${CHECKOUT_ACTION}
+      # TODO: set up your runtime and install dependencies
+      - name: Download Allure results
+        uses: ${DOWNLOAD_ARTIFACT_ACTION}
+        with:
+          pattern: allure-results-*
+          path: ./
+      - name: Generate report
+        run: |
+          npx allure generate${configOption} --dump="allure-results-*/*.zip" --output=./allure-report
+`;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.21.0",
+  "version": "3.22.1",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -27,35 +27,35 @@
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
     "start": "node ./cli.js",
-    "test": "vitest run",
+    "test": "rimraf out && vp test run",
     "test:unit": "yarn test",
-    "lint": "oxlint --import-plugin src test features stories",
-    "lint:fix": "oxlint --import-plugin --fix src test features stories"
+    "lint": "vp lint --import-plugin src test features stories",
+    "lint:fix": "vp lint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.21.0",
-    "@allurereport/ci": "3.21.0",
-    "@allurereport/cli-commons": "3.21.0",
-    "@allurereport/core": "3.21.0",
-    "@allurereport/core-api": "3.21.0",
-    "@allurereport/directory-watcher": "3.21.0",
-    "@allurereport/plugin-agent": "3.21.0",
-    "@allurereport/plugin-allure2": "3.21.0",
-    "@allurereport/plugin-api": "3.21.0",
-    "@allurereport/plugin-awesome": "3.21.0",
-    "@allurereport/plugin-classic": "3.21.0",
-    "@allurereport/plugin-csv": "3.21.0",
-    "@allurereport/plugin-dashboard": "3.21.0",
-    "@allurereport/plugin-jira": "3.21.0",
-    "@allurereport/plugin-log": "3.21.0",
-    "@allurereport/plugin-metrics": "3.21.0",
-    "@allurereport/plugin-progress": "3.21.0",
-    "@allurereport/plugin-server-reload": "3.21.0",
-    "@allurereport/plugin-slack": "3.21.0",
-    "@allurereport/plugin-xray": "3.21.0",
-    "@allurereport/reader-api": "3.21.0",
-    "@allurereport/service": "3.21.0",
-    "@allurereport/static-server": "3.21.0",
+    "@allurereport/charts-api": "3.22.1",
+    "@allurereport/ci": "3.22.1",
+    "@allurereport/cli-commons": "3.22.1",
+    "@allurereport/core": "3.22.1",
+    "@allurereport/core-api": "3.22.1",
+    "@allurereport/directory-watcher": "3.22.1",
+    "@allurereport/plugin-agent": "3.22.1",
+    "@allurereport/plugin-allure2": "3.22.1",
+    "@allurereport/plugin-api": "3.22.1",
+    "@allurereport/plugin-awesome": "3.22.1",
+    "@allurereport/plugin-classic": "3.22.1",
+    "@allurereport/plugin-csv": "3.22.1",
+    "@allurereport/plugin-dashboard": "3.22.1",
+    "@allurereport/plugin-jira": "3.22.1",
+    "@allurereport/plugin-log": "3.22.1",
+    "@allurereport/plugin-metrics": "3.22.1",
+    "@allurereport/plugin-progress": "3.22.1",
+    "@allurereport/plugin-server-reload": "3.22.1",
+    "@allurereport/plugin-slack": "3.22.1",
+    "@allurereport/plugin-xray": "3.22.1",
+    "@allurereport/reader-api": "3.22.1",
+    "@allurereport/service": "3.22.1",
+    "@allurereport/static-server": "3.22.1",
     "adm-zip": "0.6.1",
     "clipanion": "^4.0.0-rc.4",
     "glob": "^13.0.6",
@@ -65,18 +65,20 @@
     "yoctocolors": "^2.2.0"
   },
   "devDependencies": {
-    "@allurereport/test-config": "3.21.0",
+    "@allurereport/common-config": "3.22.1",
     "@types/adm-zip": "^0",
     "@types/lodash.omit": "^4.5.9",
     "@types/node": "^20",
     "@types/prompts": "^2",
-    "@vitest/coverage-istanbul": "^4.1.0",
+    "@vitest/coverage-istanbul": "5.0.4",
     "@vitest/runner": "^2",
-    "@vitest/snapshot": "^5.0.1",
+    "@vitest/snapshot": "5.0.4",
     "allure-js-commons": "^3",
     "allure-vitest": "^3",
     "rimraf": "^6",
     "typescript": "^5",
-    "vitest": "^4.1.0"
+    "vite": "@voidzero-dev/vite-plus-core@1.2.0",
+    "vite-plus": "1.2.0",
+    "vitest": "5.0.4"
   }
 }