@wpelevator/wp-release 0.6.0 → 0.6.1

package/README.md

@@ -37,7 +37,7 @@ npx wp-release --help
 | `wp-release changeset-version [options]` | Apply version bumps and changelog entries. |
 | `wp-release changeset-tag [options]` | Create missing package release tags. |
 
-Run `npx wp-release <command> --help` for the options of each command. Every command reads the plugin or theme directory from the first argument or `--source-dir`, defaulting to the current directory, and prints its result as JSON with `--json`.
+Run `npx wp-release <command> --help` for the options of each command. Every command reads the plugin or theme directory from the first argument or `--source-dir`, defaulting to the current directory, and prints its result as JSON with `--json`. In GitHub Actions, `--github-output` sets the result as JSON to the `result` output of the step instead, for later steps and jobs to read with `fromJSON( steps.<id>.outputs.result )`.
 
 ### GitHub Actions annotations and job summaries
 
@@ -127,7 +127,7 @@ Add release notes in a feature PR with `npx wp-release changeset-add --package @
 
 On the release branch, preview with `changeset-version --dry-run`, then run `changeset-version` to update version targets and changelogs. By default, new Markdown entries go before the first version heading; `changelogInsertAfter` sets a literal insertion marker for `CHANGELOG.md` and, with `readmeChangelog`, the plugin readme. Put the marker in both files; a missing marker is an error. Without a marker, plugin readmes use the `== Changelog ==` heading. Failed updates are rolled back for safe retries.
 
-After merging the release PR, `changeset-tag --since <merge-commit>^1 --push` pushes tags only for packages changed by that release. Add `--github-release` to create missing GitHub Releases; it requires `--push`. For initial adoption, preview all missing tags with `changeset-tag --dry-run` (without `--since`), then push if needed. Tag pushes need Git write credentials; GitHub Releases need authenticated `gh`.
+After merging the release PR, `changeset-tag --since <merge-commit>^1 --push` pushes tags only for packages changed by that release. It pushes one tag at a time because GitHub doesn't trigger workflows for a push of more than three tags. Add `--github-release` to create missing GitHub Releases; it requires `--push`. For initial adoption, preview all missing tags with `changeset-tag --dry-run` (without `--since`), then push if needed. To release each package with a separate workflow instead, `changeset-tag --since <merge-commit>^1 --untagged --github-output` lists the releases that don't have a tag yet, without creating any. Tag pushes need Git write credentials; GitHub Releases need authenticated `gh`.
 
 For local development, run the TypeScript source with `npm run wp-release -- <command>` (for example, `npm run wp-release -- changeset-status --since origin/main`). GitHub workflows use the same CLI for versioning and tagging. `SUBTREE_DEPLOY_TOKEN` lets them update the Version Packages PR, push tags, and create GitHub Releases.
 

package/dist/changeset-release.d.ts

@@ -9,6 +9,7 @@ export interface ChangesetVersionInput extends ChangesetRepository {
 }
 export interface ChangesetTagInput extends ChangesetRepository {
     dryRun?: boolean;
+    untagged?: boolean;
     push?: boolean;
     githubRelease?: boolean;
     since?: string;
@@ -18,6 +19,7 @@ export interface ChangesetTagResult {
         package: string;
         version: string;
         tag: string;
+        exists: boolean;
         created: boolean;
         notes: string;
     }>;

package/dist/changeset-release.js

@@ -157,6 +157,9 @@ export async function tagChangesets(input) {
     if (input.githubRelease && !input.push) {
         throw new ValidationError('GitHub Releases require pushing the tags.');
     }
+    if (input.untagged && input.push) {
+        throw new ValidationError('Listing untagged releases cannot be combined with pushing tags.');
+    }
     const context = await getReleaseContext(input);
     if (!context) {
         throw new ValidationError('No wp-release config found. Add wp-release.config.js or pass --config <path>.');
@@ -165,6 +168,7 @@ export async function tagChangesets(input) {
         ? (await changedPackagesSince(input.cwd, context.packages, input.since)).packages
         : context.packages;
     const results = [];
+    const dryRun = input.dryRun || input.untagged;
     const tagFormat = context.config.tagFormat ?? '{path}/{version}';
     for (const pkg of packages) {
         const version = 'git-tag' === pkg.versionConfig.from.kind
@@ -173,33 +177,35 @@ export async function tagChangesets(input) {
         const tag = formatTag(tagFormat, pkg, version);
         const exists = await gitTagExists(input.cwd, tag);
         const notes = await readReleaseNotes(pkg.directory, version);
-        if (!exists && !input.dryRun) {
+        if (!exists && !dryRun) {
             await git(input.cwd, ['tag', tag]);
         }
         results.push({
             package: pkg.name,
             version,
             tag,
-            created: !exists && !input.dryRun,
+            exists,
+            created: !exists && !dryRun,
             notes,
         });
     }
-    if (input.push && !input.dryRun) {
-        const created = results.filter((result) => result.created);
-        if (created.length) {
-            await git(input.cwd, [
-                'push',
-                'origin',
-                ...created.map((item) => item.tag),
-            ]);
+    // Push one tag at a time because GitHub doesn't create push events for
+    // tags when more than three are pushed at once.
+    if (input.push && !dryRun) {
+        for (const item of results.filter((result) => result.created)) {
+            await git(input.cwd, ['push', 'origin', item.tag]);
         }
     }
-    if (input.githubRelease && !input.dryRun) {
+    if (input.githubRelease && !dryRun) {
         for (const release of results) {
             await createGitHubRelease(input.cwd, release);
         }
     }
-    return { tags: results };
+    return {
+        tags: input.untagged
+            ? results.filter((result) => !result.exists)
+            : results,
+    };
 }
 async function createGitHubRelease(cwd, release) {
     try {

package/dist/cli.js

@@ -1,3 +1,4 @@
+import { appendFileSync } from 'node:fs';
 import { parseArgs } from 'node:util';
 import zip from "./commands/zip.js";
 import checksums from "./commands/checksums.js";
@@ -36,6 +37,7 @@ const globalArgs = {
     'log-format': { type: 'string' },
     ci: { type: 'boolean' },
     json: { type: 'boolean' },
+    'github-output': { type: 'boolean' },
     config: { type: 'string' },
 };
 const globalOptions = `Global options:
@@ -47,6 +49,8 @@ const globalOptions = `Global options:
                            when GITHUB_ACTIONS=true, otherwise text)
       --ci                 Same as --log-format github
       --json               Print the result as JSON
+      --github-output      Set the result as JSON to the "result" output of
+                           the GitHub Actions step
       --config <path>      Path to a JavaScript release config file`;
 /**
  * Get the top-level help text listing all commands.
@@ -143,6 +147,21 @@ function createLogWriter(values, streams) {
     }
     return create(streams);
 }
+/**
+ * Get the GitHub Actions step output file for --github-output, checked before
+ * the command runs.
+ *
+ * @param  values Parsed option values.
+ * @return Output file path, or undefined without --github-output.
+ * @throws {ValidationError} For --github-output without GITHUB_OUTPUT.
+ */
+function getGitHubOutputFile(values) {
+    const file = process.env.GITHUB_OUTPUT;
+    if (getBoolean(values, 'github-output') && !file) {
+        throw new ValidationError('--github-output requires the GITHUB_OUTPUT environment variable of GitHub Actions.');
+    }
+    return getBoolean(values, 'github-output') ? file : undefined;
+}
 /**
  * Parse the arguments of a command and run it.
  *
@@ -169,6 +188,7 @@ async function runCommand(command, args, io) {
         if ('' === configFile?.trim()) {
             throw new ValidationError('--config <path> must not be empty.');
         }
+        const githubOutputFile = getGitHubOutputFile(values);
         logger = new Logger({
             writer: createLogWriter(values, { stdout, stderr }),
             quiet: getBoolean(values, 'quiet') || getBoolean(values, 'json'),
@@ -184,6 +204,10 @@ async function runCommand(command, args, io) {
         if (getBoolean(values, 'json')) {
             stdout.write(JSON.stringify(result, null, '\t') + '\n');
         }
+        if (githubOutputFile) {
+            // Compact JSON has no line breaks, so it fits a single output line.
+            appendFileSync(githubOutputFile, `result=${JSON.stringify(result)}\n`);
+        }
         return exitCode;
     }
     catch (error) {

package/dist/commands/changeset-args.d.ts

@@ -91,6 +91,9 @@ export declare const changesetTagArgs: {
     readonly 'dry-run': {
         readonly type: "boolean";
     };
+    readonly untagged: {
+        readonly type: "boolean";
+    };
     readonly 'github-release': {
         readonly type: "boolean";
     };
@@ -102,6 +105,7 @@ export declare const changesetTagArgs: {
 export interface ChangesetTagArgs {
     push: boolean;
     dryRun: boolean;
+    untagged: boolean;
     githubRelease: boolean;
     since?: string;
 }

package/dist/commands/changeset-args.js

@@ -113,6 +113,7 @@ export function parseChangesetVersionArgs(values) {
 export const changesetTagArgs = {
     push: { type: 'boolean' },
     'dry-run': { type: 'boolean' },
+    untagged: { type: 'boolean' },
     'github-release': { type: 'boolean' },
     since: { type: 'string' },
 };
@@ -126,6 +127,7 @@ export function parseChangesetTagArgs(values) {
     const args = {
         push: getBoolean(values, 'push'),
         dryRun: getBoolean(values, 'dry-run'),
+        untagged: getBoolean(values, 'untagged'),
         githubRelease: getBoolean(values, 'github-release'),
         since: getString(values, 'since'),
     };
@@ -135,5 +137,8 @@ export function parseChangesetTagArgs(values) {
     if (args.githubRelease && !args.push) {
         throw new ValidationError('--github-release requires --push.');
     }
+    if (args.untagged && args.push) {
+        throw new ValidationError('--untagged cannot be combined with --push.');
+    }
     return args;
 }

package/dist/commands/changeset-tag.d.ts

@@ -10,6 +10,9 @@ declare const _default: {
         readonly 'dry-run': {
             readonly type: "boolean";
         };
+        readonly untagged: {
+            readonly type: "boolean";
+        };
         readonly 'github-release': {
             readonly type: "boolean";
         };

package/dist/commands/changeset-tag.js

@@ -2,17 +2,20 @@ import { tagChangesets } from "../changeset-release.js";
 import { parseChangesetTagArgs, changesetTagArgs } from "./changeset-args.js";
 export default {
     name: 'changeset-tag',
-    usage: 'changeset-tag [--dry-run] [--since <ref>] [--push] [--github-release]',
+    usage: 'changeset-tag [--dry-run] [--untagged] [--since <ref>] [--push] [--github-release]',
     summary: 'Create missing release tags for configured package versions.',
     help: `Options:
   --dry-run              List missing tags without creating them
+  --untagged             List only releases without a tag, without creating tags
   --since <ref>          Tag packages changed since this git ref
   --push                 Push newly created tags to origin
   --github-release       Create a GitHub Release for each tag
 
 Tags are created only when absent, and GitHub Releases are created only when
 missing, so rerunning after a partial failure is safe. --github-release also
-requires --push.`,
+requires --push. With --json or --github-output, --untagged lists the releases
+that still need a tag, for example to release each of them with a separate
+workflow.`,
     options: changesetTagArgs,
     async run({ values, cwd, configFile, logger }) {
         const args = parseChangesetTagArgs(values);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wpelevator/wp-release",
-	"version": "0.6.0",
+	"version": "0.6.1",
 	"description": "Package, checksum, sign, verify and version-check WordPress plugins and themes, and deploy plugins to WordPress.org SVN",
 	"license": "MIT",
 	"repository": {