@tallyrelease/cli 0.2.0-beta.7 → 0.2.0-beta.9

package/README.md

@@ -42,7 +42,7 @@ Global flags: `--cwd <dir>` (repository root), `--config <file>` (default `tally
 - `tallyrelease check` validates config, plugins, units, graph and release config; with released units it also checks the repository's tags.
 - `tallyrelease graph [--format text|json|mermaid] [--json]` prints units and edges.
 - `tallyrelease affected [--base <ref>] [--format text|json|tsv] [--json] [--out <file>] [--github-output] [--tag <tag>]` computes the build set. `--out` writes the affected document as JSON, `--github-output` appends outputs to `$GITHUB_OUTPUT`. `--tag` (repeatable) keeps units with any of the given tags.
-- `tallyrelease plan [--branch <name>] [--base <ref>] [--head <ref>] [--all] [--format text|json] [--json] [--out <file>] [--github-output]` computes the release plan without changing anything: kind, base version, bump, next version and prerelease version per unit. `--head` plans another commit with the current config, `--all` also lists released units with a pending release outside the build set. `--github-output` writes `plan`, the path of the written plan (`--out`, else `$RUNNER_TEMP/tallyrelease-plan.json`). The JSON schema is exported as `@tallyrelease/cli/plan.schema.json`.
+- `tallyrelease plan [--branch <name>] [--base <ref>] [--head <ref>] [--all] [--format text|json] [--json] [--out <file>] [--github-output] [--summary]` computes the release plan without changing anything: kind, base version, bump, next version and prerelease version per unit. `--head` plans another commit with the current config, `--all` also lists released units with a pending release outside the build set. `--github-output` writes `plan`, the path of the written plan (`--out`, else `$RUNNER_TEMP/tallyrelease-plan.json`). `--summary` appends a markdown summary to `$GITHUB_STEP_SUMMARY`, or prints it instead of the table when unset (exit 2 with `--json` then). The JSON schema is exported as `@tallyrelease/cli/plan.schema.json`.
 - `tallyrelease explain <unit> [--branch <name>] [--base <ref>]` explains a unit: why it is affected, which commits and files bump it (including changes absorbed from unreleased dependencies), propagation and Release-As footers.
 
 - `tallyrelease shadow [--manifest <path>] [--rp-config <path>] [--head <ref>] [--branch <name>] [--pin <spec>] [--out <file>] [--summary] [--strict]` compares tallyrelease with a release-please release: on a push that changes the release-please manifest, it plans the parent commit and compares each unit's next version with the new manifest value. See [Shadow mode](#shadow-mode).

package/dist/ci/summary.d.ts

@@ -0,0 +1,2 @@
+/** Appends markdown to `$GITHUB_STEP_SUMMARY`; false when it is not set. */
+export declare const appendStepSummary: (env: Readonly<Record<string, string | undefined>>, markdown: string) => boolean;

package/dist/ci/summary.js

@@ -0,0 +1,10 @@
+import { appendFileSync } from "node:fs";
+/** Appends markdown to `$GITHUB_STEP_SUMMARY`; false when it is not set. */
+export const appendStepSummary = (env, markdown) => {
+    const path = env["GITHUB_STEP_SUMMARY"];
+    if (!path) {
+        return false;
+    }
+    appendFileSync(path, markdown);
+    return true;
+};

package/dist/commands/plan.d.ts

@@ -10,6 +10,7 @@ export interface PlanFlags {
     json?: boolean;
     out?: string;
     githubOutput?: boolean;
+    summary?: boolean;
 }
 export interface PlanSetup {
     opts: Omit<PlanOptions, "fs">;

package/dist/commands/plan.js

@@ -1,8 +1,9 @@
 import { TallyError } from "@tallyrelease/core";
 import { appendFileSync, writeFileSync } from "node:fs";
 import { join, resolve } from "node:path";
-import { baseLine, resolveBuildBase } from "../ci/base.js";
+import { baseLabel, baseLine, resolveBuildBase } from "../ci/base.js";
 import { planGithubOutput } from "../ci/outputs.js";
+import { appendStepSummary } from "../ci/summary.js";
 import { alignColumns } from "../output/columns.js";
 import { count } from "../output/count.js";
 import { painter } from "../output/paint.js";
@@ -53,6 +54,27 @@ const text = (session, doc, base) => {
     lines.push(paint("bold", header), ...rows, "", `${count(doc.units.length, "unit")} planned: ${kinds.join(", ")}`);
     return `${lines.join("\n")}\n`;
 };
+const markdown = (doc, base) => {
+    const lines = [
+        "### tallyrelease plan",
+        "",
+        `Branch ${lineLabel(doc.line, doc.branch)}.`,
+        "",
+        `Base ${base.base?.slice(0, 7) ?? "none"} (${baseLabel(base)}).`,
+        "",
+    ];
+    if (doc.units.length === 0) {
+        lines.push("No units planned.");
+    }
+    else {
+        const grouped = doc.units.some((u) => u.group !== null);
+        lines.push(`| Unit |${grouped ? " Group |" : ""} Kind | From | Bump | Next | Version |`, `| :-- |${grouped ? " :-- |" : ""} :-- | :-- | :-- | :-- | :-- |`, ...doc.units.map((u) => `| ${u.id} |${grouped ? ` ${u.group ?? "-"} |` : ""} ${u.kind} | ${u.from ?? "-"} | ${u.bump ?? "-"} | ${u.next ?? "-"} | ${u.version ?? "-"} |`));
+    }
+    if (doc.warnings.length > 0) {
+        lines.push("", "Warnings:", "", ...doc.warnings.map((w) => `- ${w.code}: ${w.message}`));
+    }
+    return `${lines.join("\n")}\n`;
+};
 /**
  * Plan options for `--branch`, `--base` and `--head`. With `--head` only
  * `--base` and the local merge base apply, and files come from the commit.
@@ -129,6 +151,11 @@ export const plan = async (session, flags) => {
         }
         appendFileSync(outputPath, planGithubOutput(path));
     }
+    const appended = flags.summary && appendStepSummary(session.env, markdown(doc, base));
     const format = flags.format ?? (flags.json ? "json" : "text");
-    session.stdout.write(format === "json" ? json : text(session, doc, base));
+    session.stdout.write(format === "json"
+        ? json
+        : flags.summary && !appended
+            ? markdown(doc, base)
+            : text(session, doc, base));
 };

package/dist/commands/shadow.js

@@ -1,6 +1,7 @@
 import { computePlan, TallyError } from "@tallyrelease/core";
-import { appendFileSync, writeFileSync } from "node:fs";
+import { writeFileSync } from "node:fs";
 import { resolve } from "node:path";
+import { appendStepSummary } from "../ci/summary.js";
 import { alignColumns } from "../output/columns.js";
 import { count } from "../output/count.js";
 import { branchName } from "../session.js";
@@ -139,11 +140,8 @@ const writeReport = (session, flags, report) => {
     if (flags.out !== undefined) {
         writeFileSync(resolve(session.cwd, flags.out), `${JSON.stringify(report, null, 2)}\n`);
     }
-    const stepSummary = env["GITHUB_STEP_SUMMARY"];
-    if (flags.summary && stepSummary) {
-        appendFileSync(stepSummary, markdown(report));
-    }
-    session.stdout.write(flags.summary && !stepSummary ? markdown(report) : text(report));
+    const appended = flags.summary && appendStepSummary(env, markdown(report));
+    session.stdout.write(flags.summary && !appended ? markdown(report) : text(report));
     if (env["GITHUB_ACTIONS"] === "true") {
         for (const r of unlabelled(report.rows)) {
             session.stdout.write(`::warning title=tallyrelease shadow::${escapeData(`${r.path}: ${r.status} (release-please ${r.after ?? "-"}, tallyrelease ${r.next ?? "-"})`)}\n`);

package/dist/main.js

@@ -79,10 +79,16 @@ export const main = async (argv, deps) => {
     ]))
         .option("--out <file>", "write the plan to a file")
         .option("--github-output", "append outputs to $GITHUB_OUTPUT")
+        .option("--summary", "write markdown to $GITHUB_STEP_SUMMARY, else print it instead of the table")
         .action(async (flags, cmd) => {
         if (flags.json && flags.format !== undefined) {
             cmd.error("--json and --format cannot be combined", { exitCode: 2 });
         }
+        if (flags.summary &&
+            (flags.json || flags.format === "json") &&
+            !deps.env["GITHUB_STEP_SUMMARY"]) {
+            cmd.error("--summary needs GITHUB_STEP_SUMMARY when printing JSON; both use stdout", { exitCode: 2 });
+        }
         await plan(session(), flags);
     });
     program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tallyrelease/cli",
-  "version": "0.2.0-beta.7",
+  "version": "0.2.0-beta.9",
   "description": "Command line interface of tallyrelease",
   "repository": {
     "type": "git",