@wpelevator/wp-release 0.10.0 → 0.11.0

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

@@ -104,9 +104,6 @@ export declare const changesetTagArgs: {
     readonly untagged: {
         readonly type: "boolean";
     };
-    readonly 'github-release': {
-        readonly type: "boolean";
-    };
     readonly since: {
         readonly type: "string";
     };
@@ -123,7 +120,6 @@ export interface ChangesetTagArgs {
     push: boolean;
     dryRun: boolean;
     untagged: boolean;
-    githubRelease: boolean;
     since?: string;
     packages: string[];
     version?: string;

package/dist/commands/changeset-args.js

@@ -122,7 +122,6 @@ export const changesetTagArgs = {
     push: { type: 'boolean' },
     'dry-run': { type: 'boolean' },
     untagged: { type: 'boolean' },
-    'github-release': { type: 'boolean' },
     since: { type: 'string' },
     package: { type: 'string', multiple: true },
     version: { type: 'string' },
@@ -138,7 +137,6 @@ export function parseChangesetTagArgs(values) {
         push: getBoolean(values, 'push'),
         dryRun: getBoolean(values, 'dry-run'),
         untagged: getBoolean(values, 'untagged'),
-        githubRelease: getBoolean(values, 'github-release'),
         since: getString(values, 'since'),
         packages: getStrings(values, 'package'),
         version: getString(values, 'version')?.trim(),
@@ -155,9 +153,6 @@ export function parseChangesetTagArgs(values) {
     if (undefined !== args.version && 1 !== args.packages.length) {
         throw new ValidationError('--version <version> requires exactly one --package <name>.');
     }
-    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.');
     }

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

@@ -13,9 +13,6 @@ declare const _default: {
         readonly untagged: {
             readonly type: "boolean";
         };
-        readonly 'github-release': {
-            readonly type: "boolean";
-        };
         readonly since: {
             readonly type: "string";
         };

package/dist/commands/changeset-tag.js

@@ -3,7 +3,7 @@ import { parseChangesetTagArgs, changesetTagArgs } from "./changeset-args.js";
 import { getChangesetTagSummary, getTagStatus } from "../summary.js";
 export default {
     name: 'changeset-tag',
-    usage: 'changeset-tag [--dry-run] [--untagged] [--since <ref>] [--package <name>] [--version <version>] [--push] [--github-release]',
+    usage: 'changeset-tag [--dry-run] [--untagged] [--since <ref>] [--package <name>] [--version <version>] [--push]',
     summary: 'Create missing release tags for configured package versions.',
     help: `Options:
   --dry-run              List missing tags and their release notes without
@@ -13,16 +13,14 @@ export default {
   --package <name>       Tag only this package (repeatable)
   --version <version>    Fail unless the single --package is at this version;
                          the version to tag for packages versioned by git tags
-  --push                 Push newly created tags to origin
-  --github-release       Create a GitHub Release for each tag, marked as a
-                         pre-release for versions like 1.0.0-rc.1
+  --push                 Push newly created tags to origin, one at a time
 
-Tags are created only when absent, and GitHub Releases are created only when
-missing, so rerunning after a partial failure is safe. Before a tag is created,
-every configured version target must match the version. --github-release also
-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.`,
+Tags are created only when absent, so rerunning after a partial failure is
+safe. Before a tag is created, every configured version target must match the
+version. With --json or --github-output, each tag comes with the title, notes
+and pre-release flag of its release, for a workflow step that creates the
+GitHub Release. --untagged lists only 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/dist/file-journal.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Original contents of the files that a versioning run changes, so that a
+ * failed run can put every file back the way it was.
+ */
+export declare class FileJournal {
+    /** Original contents by file, undefined for files that didn't exist. */
+    private readonly files;
+    /**
+     * Remember the contents of a file before its first change. Later calls
+     * for the same file keep the original contents.
+     *
+     * @param file File about to change.
+     */
+    remember(file: string): Promise<void>;
+    /**
+     * Put the remembered files back in reverse order, removing the files that
+     * didn't exist. Every file is attempted, even after a failure.
+     *
+     * @return Errors of the files that couldn't be restored.
+     */
+    restore(): Promise<Error[]>;
+}

package/dist/file-journal.js

@@ -0,0 +1,56 @@
+import { readFile, rm, writeFile } from 'node:fs/promises';
+/**
+ * Original contents of the files that a versioning run changes, so that a
+ * failed run can put every file back the way it was.
+ */
+export class FileJournal {
+    /** Original contents by file, undefined for files that didn't exist. */
+    files = new Map();
+    /**
+     * Remember the contents of a file before its first change. Later calls
+     * for the same file keep the original contents.
+     *
+     * @param file File about to change.
+     */
+    async remember(file) {
+        if (this.files.has(file)) {
+            return;
+        }
+        try {
+            this.files.set(file, await readFile(file, 'utf8'));
+        }
+        catch (error) {
+            if ('ENOENT' !== error.code) {
+                throw error;
+            }
+            this.files.set(file, undefined);
+        }
+    }
+    /**
+     * Put the remembered files back in reverse order, removing the files that
+     * didn't exist. Every file is attempted, even after a failure.
+     *
+     * @return Errors of the files that couldn't be restored.
+     */
+    async restore() {
+        const errors = [];
+        for (const [file, contents] of [
+            ...this.files.entries(),
+        ].reverse()) {
+            try {
+                if (undefined === contents) {
+                    await rm(file, { force: true });
+                }
+                else {
+                    await writeFile(file, contents);
+                }
+            }
+            catch (error) {
+                errors.push(error instanceof Error
+                    ? error
+                    : new Error(String(error)));
+            }
+        }
+        return errors;
+    }
+}

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export { isUrl, downloadFile } from './download.ts';
 export { readZipEntries, getZipEntryErrors, extractZip } from './unzip.ts';
 export { GIT_TAG_FORMAT, VersionMismatchError, getGitTagVersion, findConstantValues, findConstantDefinitions, findVersionMismatches, getVersionMismatchProblems, } from './version-check.ts';
 export { CHANGESET_BUMPS, parseChangeset, formatChangeset, formatChangelogEntries, formatChangelogList, getChangesetBump, getNextVersion, } from './changesets.ts';
-export { addChangeset, getChangesetPackages, getChangesetReleasePlan, getChangesetStatus, versionChangesets, tagChangesets, } from './changeset-release.ts';
+export { ChangesetRelease, addChangeset, getChangesetPackages, getChangesetReleasePlan, getChangesetStatus, versionChangesets, tagChangesets, } from './changeset-release.ts';
 export { defineConfig, packageJsonVersion, composerJsonVersion, wordpressPluginVersion, wordpressThemeVersion, wordpressStableTag, gitTagVersion, phpConstantVersion, loadChangesetConfig, } from './changeset-config.ts';
 export { Svn, SvnError, createSvnRunner, parseStatus, toSvnPath, } from './svn.ts';
 export { syncDirectory, copyFileIfChanged } from './sync.ts';
@@ -42,7 +42,7 @@ export type { CreateZipInput } from './zip.ts';
 export type { ExtractZipInput, ZipEntryInfo, ZipEntryType } from './unzip.ts';
 export type { FindVersionMismatchesInput, GitTagInput, VersionCheckResult, VersionMismatch, } from './version-check.ts';
 export type { Changeset, ChangesetBump, ChangesetPackages, ChangesetConfig, ChangesetPackageType, ChangesetPackage, PackageRelease, VersionedRelease, ChangesetReleasePlan, } from './changesets.ts';
-export type { ChangesetRepository, ChangesetVersionInput, VersionChangesetsResult, ChangesetTagInput, ChangesetTagResult, } from './changeset-release.ts';
+export type { ChangesetRepository, ChangesetReleaseOptions, ChangesetAddOptions, ChangesetVersionOptions, ChangesetTagOptions, ChangesetStatusOptions, ChangesetStatusResult, ChangesetVersionInput, VersionChangesetsResult, ChangesetTagInput, ChangesetTagResult, } from './changeset-release.ts';
 export type { WpReleaseConfig, ChangesetPackageGroup, PackageVersionConfig, PackageVersionSource, PackageVersionTarget, PackageIdSource, NextVersionInput, ReleaseCommit, ReleaseNotesInput, ChangelogEntryInput, DependentsChangelogInput, DependentsConfig, PackageJsonVersionOptions, ComposerJsonVersionOptions, WordPressVersionFileOptions, GitTagVersionOptions, PhpConstantVersionOptions, LoadChangesetConfigInput, } from './changeset-config.ts';
 export type { SvnCheckoutInput, SvnCommandInput, SvnCommandOutput, SvnCommitInput, SvnCopyInput, SvnDepth, SvnOptions, SvnPathsInput, SvnPropsetInput, SvnRunner, SvnStatusEntry, SvnStatusType, SvnUpdateInput, } from './svn.ts';
 export type { SyncDirectoryInput, SyncResult } from './sync.ts';

package/dist/index.js

@@ -15,7 +15,7 @@ export { isUrl, downloadFile } from "./download.js";
 export { readZipEntries, getZipEntryErrors, extractZip } from "./unzip.js";
 export { GIT_TAG_FORMAT, VersionMismatchError, getGitTagVersion, findConstantValues, findConstantDefinitions, findVersionMismatches, getVersionMismatchProblems, } from "./version-check.js";
 export { CHANGESET_BUMPS, parseChangeset, formatChangeset, formatChangelogEntries, formatChangelogList, getChangesetBump, getNextVersion, } from "./changesets.js";
-export { addChangeset, getChangesetPackages, getChangesetReleasePlan, getChangesetStatus, versionChangesets, tagChangesets, } from "./changeset-release.js";
+export { ChangesetRelease, addChangeset, getChangesetPackages, getChangesetReleasePlan, getChangesetStatus, versionChangesets, tagChangesets, } from "./changeset-release.js";
 export { defineConfig, packageJsonVersion, composerJsonVersion, wordpressPluginVersion, wordpressThemeVersion, wordpressStableTag, gitTagVersion, phpConstantVersion, loadChangesetConfig, } from "./changeset-config.js";
 export { Svn, SvnError, createSvnRunner, parseStatus, toSvnPath, } from "./svn.js";
 export { syncDirectory, copyFileIfChanged } from "./sync.js";

package/dist/json-files.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Read a JSON manifest that has to exist.
+ *
+ * @param  file JSON file.
+ * @return Parsed object.
+ * @throws {ValidationError} If the file is missing or isn't valid JSON.
+ */
+export declare function readJson(file: string): Promise<Record<string, unknown>>;
+/**
+ * Read an optional JSON manifest.
+ *
+ * @param file JSON file.
+ * @return Parsed object, or undefined when the file doesn't exist.
+ */
+export declare function readJsonIfExists(file: string): Promise<Record<string, unknown> | undefined>;

package/dist/json-files.js

@@ -0,0 +1,35 @@
+import { readFile } from 'node:fs/promises';
+import { ValidationError } from "./errors.js";
+/**
+ * Read a JSON manifest that has to exist.
+ *
+ * @param  file JSON file.
+ * @return Parsed object.
+ * @throws {ValidationError} If the file is missing or isn't valid JSON.
+ */
+export async function readJson(file) {
+    try {
+        return JSON.parse(await readFile(file, 'utf8'));
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        throw new ValidationError(`Could not read JSON manifest ${file}: ${message}`);
+    }
+}
+/**
+ * Read an optional JSON manifest.
+ *
+ * @param file JSON file.
+ * @return Parsed object, or undefined when the file doesn't exist.
+ */
+export async function readJsonIfExists(file) {
+    try {
+        return JSON.parse(await readFile(file, 'utf8'));
+    }
+    catch (error) {
+        if ('ENOENT' !== error.code) {
+            throw error;
+        }
+        return undefined;
+    }
+}

package/dist/package-meta.js

@@ -1,6 +1,7 @@
 import { open, readdir, readFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { isErrorCode } from "./file-selection.js";
+import { escapeRegExp } from "./regexp.js";
 /**
  * Number of bytes that WordPress reads from a file to parse its headers.
  */
@@ -112,9 +113,6 @@ export function findFileHeaderLine(contents, header) {
 export function getLineNumber(contents, index) {
     return contents.slice(0, index).split('\n').length;
 }
-function escapeRegExp(text) {
-    return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}
 /**
  * Parse the headers of a readme.txt or readme.md, the "Key: value" lines
  * between the title and the first section. Markdown emphasis around the

package/dist/regexp.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Escape text for use as a literal in a regular expression.
+ *
+ * @param text Text to match literally.
+ * @return Escaped pattern.
+ */
+export declare function escapeRegExp(text: string): string;

package/dist/regexp.js

@@ -0,0 +1,9 @@
+/**
+ * Escape text for use as a literal in a regular expression.
+ *
+ * @param text Text to match literally.
+ * @return Escaped pattern.
+ */
+export function escapeRegExp(text) {
+    return text.replaceAll(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}

package/dist/release-repository.d.ts

@@ -0,0 +1,102 @@
+import type { ReleaseCommit } from './changeset-config.ts';
+import type { GitRunner } from './git.ts';
+export interface ReleaseRepositoryOptions {
+    /** Repository root that relative paths resolve against. */
+    cwd: string;
+    /** Git runner, spawning git by default. */
+    runner?: GitRunner;
+}
+export interface ChangedFilesOptions {
+    /** Directory to limit the diff to. */
+    directory?: string;
+    /** Value of --diff-filter, like ACMR for files that still exist. */
+    diffFilter?: string;
+}
+/**
+ * The git queries and writes of a changeset release: tags, the commits of a
+ * package and the files changed since a ref.
+ *
+ * Every command runs through the runner, so that tests can replace git, and
+ * fails with a ValidationError that names the command.
+ */
+export declare class ReleaseRepository {
+    readonly cwd: string;
+    readonly runner: GitRunner;
+    /**
+     * @param options Repository root and git runner.
+     */
+    constructor(options: ReleaseRepositoryOptions);
+    /**
+     * Run a git command in the repository. The repository is marked as a safe
+     * directory, because CI containers often check it out as another user.
+     *
+     * @param  args Arguments after "git".
+     * @return Standard output.
+     * @throws {ValidationError} If the command fails.
+     */
+    run(args: string[]): Promise<string>;
+    /**
+     * Get the path of a file relative to the repository root, with forward
+     * slashes as git expects.
+     *
+     * @param file Absolute or relative file path.
+     * @return Relative path, empty for the root itself.
+     */
+    relativePath(file: string): string;
+    /**
+     * Check whether a tag exists.
+     *
+     * @param tag Tag name.
+     * @return Whether the tag exists.
+     */
+    tagExists(tag: string): Promise<boolean>;
+    /**
+     * List the tags that start with a prefix.
+     *
+     * @param prefix Tag prefix, like `plugins/alpha/`.
+     * @return Tag names.
+     */
+    listTags(prefix: string): Promise<string[]>;
+    /**
+     * Tag the current commit.
+     *
+     * @param tag Tag name.
+     */
+    createTag(tag: string): Promise<void>;
+    /**
+     * Push a tag to the origin remote.
+     *
+     * @param tag Tag name.
+     */
+    pushTag(tag: string): Promise<void>;
+    /**
+     * Find the commit that added a file.
+     *
+     * @param file File path.
+     * @return Commit, or undefined when the file isn't committed.
+     */
+    getAddedCommit(file: string): Promise<ReleaseCommit | undefined>;
+    /**
+     * List the commits of a revision range that changed a directory.
+     *
+     * @param revision  Revision range, like `plugins/alpha/1.0.0..HEAD`.
+     * @param directory Directory the commits changed.
+     * @return Commits, newest first.
+     */
+    getDirectoryCommits(revision: string, directory: string): Promise<ReleaseCommit[]>;
+    /**
+     * List the files changed between the merge base of a ref and HEAD.
+     *
+     * @param since   Base ref, like origin/main.
+     * @param options Directory and diff filter.
+     * @return Changed files relative to the repository root.
+     */
+    getChangedFiles(since: string, options?: ChangedFilesOptions): Promise<string[]>;
+    /**
+     * Run git log and parse the commits.
+     *
+     * @param args Arguments after the format option.
+     * @return Commits, newest first.
+     */
+    private getCommits;
+}

package/dist/release-repository.js

@@ -0,0 +1,159 @@
+import path from 'node:path';
+import { ValidationError } from "./errors.js";
+import { createGitRunner } from "./git.js";
+/**
+ * The git queries and writes of a changeset release: tags, the commits of a
+ * package and the files changed since a ref.
+ *
+ * Every command runs through the runner, so that tests can replace git, and
+ * fails with a ValidationError that names the command.
+ */
+export class ReleaseRepository {
+    cwd;
+    runner;
+    /**
+     * @param options Repository root and git runner.
+     */
+    constructor(options) {
+        this.cwd = path.resolve(options.cwd);
+        this.runner = options.runner ?? createGitRunner();
+    }
+    /**
+     * Run a git command in the repository. The repository is marked as a safe
+     * directory, because CI containers often check it out as another user.
+     *
+     * @param  args Arguments after "git".
+     * @return Standard output.
+     * @throws {ValidationError} If the command fails.
+     */
+    async run(args) {
+        try {
+            const { stdout } = await this.runner({
+                args: ['-c', `safe.directory=${this.cwd}`, ...args],
+                cwd: this.cwd,
+            });
+            return stdout;
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            throw new ValidationError(`Git command failed (${args.join(' ')}): ${message}`);
+        }
+    }
+    /**
+     * Get the path of a file relative to the repository root, with forward
+     * slashes as git expects.
+     *
+     * @param file Absolute or relative file path.
+     * @return Relative path, empty for the root itself.
+     */
+    relativePath(file) {
+        return path.relative(this.cwd, file).split(path.sep).join('/');
+    }
+    /**
+     * Check whether a tag exists.
+     *
+     * @param tag Tag name.
+     * @return Whether the tag exists.
+     */
+    async tagExists(tag) {
+        const output = await this.run(['tag', '--list', tag]);
+        return output.trim() === tag;
+    }
+    /**
+     * List the tags that start with a prefix.
+     *
+     * @param prefix Tag prefix, like `plugins/alpha/`.
+     * @return Tag names.
+     */
+    async listTags(prefix) {
+        const output = await this.run(['tag', '--list', `${prefix}*`]);
+        return output.trim().split(/\r?\n/).filter(Boolean);
+    }
+    /**
+     * Tag the current commit.
+     *
+     * @param tag Tag name.
+     */
+    async createTag(tag) {
+        await this.run(['tag', tag]);
+    }
+    /**
+     * Push a tag to the origin remote.
+     *
+     * @param tag Tag name.
+     */
+    async pushTag(tag) {
+        await this.run(['push', 'origin', tag]);
+    }
+    /**
+     * Find the commit that added a file.
+     *
+     * @param file File path.
+     * @return Commit, or undefined when the file isn't committed.
+     */
+    async getAddedCommit(file) {
+        const [commit] = await this.getCommits([
+            '--diff-filter=A',
+            '-1',
+            '--',
+            this.relativePath(file),
+        ]);
+        return commit;
+    }
+    /**
+     * List the commits of a revision range that changed a directory.
+     *
+     * @param revision  Revision range, like `plugins/alpha/1.0.0..HEAD`.
+     * @param directory Directory the commits changed.
+     * @return Commits, newest first.
+     */
+    async getDirectoryCommits(revision, directory) {
+        return this.getCommits([
+            revision,
+            '--',
+            this.relativePath(directory) || '.',
+        ]);
+    }
+    /**
+     * List the files changed between the merge base of a ref and HEAD.
+     *
+     * @param since   Base ref, like origin/main.
+     * @param options Directory and diff filter.
+     * @return Changed files relative to the repository root.
+     */
+    async getChangedFiles(since, options = {}) {
+        const output = await this.run([
+            'diff',
+            '--name-only',
+            ...(options.diffFilter
+                ? [`--diff-filter=${options.diffFilter}`]
+                : []),
+            `${since}...HEAD`,
+            ...(options.directory
+                ? ['--', this.relativePath(options.directory)]
+                : []),
+        ]);
+        return output.trim().split(/\r?\n/).filter(Boolean);
+    }
+    /**
+     * Run git log and parse the commits.
+     *
+     * @param args Arguments after the format option.
+     * @return Commits, newest first.
+     */
+    async getCommits(args) {
+        const output = await this.run([
+            'log',
+            '--format=%H%x1f%h%x1f%s',
+            ...args,
+        ]);
+        return output
+            .trim()
+            .split(/\r?\n/)
+            .filter(Boolean)
+            .map((line) => {
+            const [hash = '', shortHash = '', subject = ''] = line.split('\x1f');
+            return { hash, shortHash, subject };
+        });
+    }
+}

package/dist/release-tags.d.ts

@@ -0,0 +1,56 @@
+import type { ChangesetConfig } from './changeset-config.ts';
+import type { ConfiguredPackage } from './changeset-packages.ts';
+import type { ReleaseRepository } from './release-repository.ts';
+/**
+ * Version, tag and previous tag of a package release.
+ */
+export interface ReleaseTag {
+    /** Released version. */
+    version: string;
+    /** Release tag. */
+    tag: string;
+    /** Tag of the previous release, if any. */
+    previousTag?: string;
+}
+/**
+ * Pick the packages to tag.
+ *
+ * @param  packages Configured packages.
+ * @param  names    Packages passed with --package, empty for all.
+ * @param  version  Expected version passed with --version, if any.
+ * @return Selected packages in the configured order.
+ * @throws {ValidationError} For unknown packages, or an expected version without a single package.
+ */
+export declare function selectTagPackages(packages: ConfiguredPackage[], names: string[], version?: string): ConfiguredPackage[];
+/**
+ * Get the version to tag. Packages versioned by their git tags have no
+ * version file, so the expected version is the version to tag, or else the
+ * latest CHANGELOG.md version.
+ *
+ * @param pkg      Configured package.
+ * @param expected Expected version from --version, if any.
+ * @return Version to tag.
+ */
+export declare function getTagVersion(pkg: ConfiguredPackage, expected?: string): Promise<string>;
+/**
+ * Find the tag of the newest release before a version.
+ *
+ * @param repository Repository with the tags.
+ * @param prefix     Tag prefix of the package, like `plugins/alpha/`.
+ * @param version    Version being released.
+ * @return Previous tag, or undefined for the first release.
+ */
+export declare function getPreviousTag(repository: ReleaseRepository, prefix: string, version: string): Promise<string | undefined>;
+/**
+ * Build the release notes of a tag from its CHANGELOG.md section, or from the
+ * commits since the previous release without one, with the configured
+ * formatter.
+ *
+ * @param repository Repository with the release commits.
+ * @param config     Repository release configuration.
+ * @param pkg        Released package.
+ * @param release    Version, tag and previous tag of the release.
+ * @param end        Commit of the release: the tag, or HEAD before tagging.
+ * @return Release notes.
+ */
+export declare function getReleaseNotes(repository: ReleaseRepository, config: ChangesetConfig, pkg: ConfiguredPackage, release: ReleaseTag, end: string): Promise<string>;