@wpelevator/wp-release 0.11.0 → 0.12.0

package/README.md

@@ -132,14 +132,13 @@ 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.
 
-Configure `changelogEntry( { package, changeset, commit } )` to format the changelog entry of each changeset, where `commit` is the `{ hash, shortHash, subject }` of the commit that added the changeset file, if it's committed. The formatted entries go into `CHANGELOG.md`, the `changelog` of each release in the `changeset-version` result, and so the release notes; plugin readmes keep the plain summaries. `getGitHubPullRequest( { cwd, commit } )` finds the `{ number, url, author }` of the pull request that merged a commit with the authenticated `gh` CLI, for example to credit it:
+Configure `changelogEntry( { package, changeset, commit } )` to format the changelog entry of each changeset, where `commit` is the `{ hash, shortHash, subject }` of the commit that added the changeset file, if it's committed. The formatted entries go into `CHANGELOG.md`, the `changelog` of each release in the `changeset-version` result, and so the release notes; plugin readmes keep the plain summaries. Without the callback, entries are the plain summaries. For example, to link each entry to its commit:
 
 ```js
-changelogEntry: async ( { changeset, commit } ) => {
-	const pullRequest = commit && ( await getGitHubPullRequest( { cwd: import.meta.dirname, commit: commit.hash } ) );
-
-	return pullRequest ? `${ changeset.summary } (#${ pullRequest.number } by @${ pullRequest.author })` : changeset.summary;
-},
+changelogEntry: ( { changeset, commit } ) =>
+	commit
+		? `${ changeset.summary } ([\`${ commit.shortHash }\`](https://github.com/me/repo/commit/${ commit.hash }))`
+		: changeset.summary,
 ```
 
 Configure `dependents` to re-release packages that bundle a package when it releases. The dependents come from what the packages declare: a package is a dependent of a source when the spec that it declares in its npm `dependencies` or `optionalDependencies` (or the sections that the policy adds) resolves the current version of the source or points at the workspace, and it re-releases when the next version of the source falls outside the declared range, or always with `when: 'always'`. A pin to an older version selects a registry release instead and `changeset-status` warns about the drift until the pin resolves the package again. Versioning a dependent rewrites its declared specs of the source to the released version, keeping their range prefixes, so an exact pin matches the released workspace again and the built bundle matches the changelog. Wildcards and unpinned ranges accept the release without one, like the `devDependencies` of a package. The derived dependents appear in `changeset-status`, `changeset-version` and `changeset-tag` like any other release, and a dependent that releases for its own reasons keeps its own bump and appends the bundle note:
@@ -651,7 +650,6 @@ The changeset release modules, from the entry point down:
 | `release-tags.ts` | Choosing the version and previous tag of a release, and building its release notes. |
 | `tag-format.ts` | Formatting tag names from the tag format. |
 | `release-repository.ts` | `ReleaseRepository`, the git commands of a release: tags, commits and changed files. |
-| `github.ts` | Finding the pull request of a commit with the GitHub CLI, for changelog formatters. |
 | `file-journal.ts` | `FileJournal`, which restores every file a failed `changeset-version` run changed. |
 | `versions.ts` | Version checks and SemVer precedence. |
 

package/dist/index.d.ts

@@ -47,8 +47,6 @@ export type { WpReleaseConfig, ChangesetPackageGroup, PackageVersionConfig, Pack
 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';
 export type { SummaryContext } from './summary.ts';
-export { getGitHubPullRequest } from './github.ts';
-export type { GitHubPullRequest, GetGitHubPullRequestInput } from './github.ts';
 export type { CheckoutPath, DeployResult } from './svn-deploy.ts';
 export type { GitCommandInput, GitCommandOutput, GitRunner } from './git.ts';
 export type { GitDeployInput, GitDeployOptions, GitDeployResult, } from './git-deploy.ts';

package/dist/index.js

@@ -23,4 +23,3 @@ export { ASSET_MIME_TYPES, SvnDeploy } from "./svn-deploy.js";
 export { GitError, createGitRunner, redactUrls } from "./git.js";
 export { GitDeploy, isValidRefName, resolveGitDeployOptions, } from "./git-deploy.js";
 export { getGitDeployInputFromArgs } from "./commands/deploy-git.js";
-export { getGitHubPullRequest } from "./github.js";

package/package.json

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

package/dist/github.d.ts

@@ -1,24 +0,0 @@
-/**
- * A GitHub pull request of a commit.
- */
-export interface GitHubPullRequest {
-    number: number;
-    url: string;
-    /** GitHub handle of the pull request author, without the @. */
-    author: string;
-}
-export interface GetGitHubPullRequestInput {
-    /** Directory of the repository, whose GitHub remote `gh` uses. */
-    cwd: string;
-    /** Commit hash. */
-    commit: string;
-}
-/**
- * Find the pull request that merged a commit, with the authenticated `gh`
- * command line client.
- *
- * @param  input Repository directory and commit.
- * @return The first pull request of the commit, or undefined without one.
- * @throws {ValidationError} If `gh` fails, like without authentication.
- */
-export declare function getGitHubPullRequest(input: GetGitHubPullRequestInput): Promise<GitHubPullRequest | undefined>;

package/dist/github.js

@@ -1,30 +0,0 @@
-import { execFile } from 'node:child_process';
-import { promisify } from 'node:util';
-import { ValidationError } from "./errors.js";
-const execFileAsync = promisify(execFile);
-/**
- * Find the pull request that merged a commit, with the authenticated `gh`
- * command line client.
- *
- * @param  input Repository directory and commit.
- * @return The first pull request of the commit, or undefined without one.
- * @throws {ValidationError} If `gh` fails, like without authentication.
- */
-export async function getGitHubPullRequest(input) {
-    let stdout;
-    try {
-        ({ stdout } = await execFileAsync('gh', ['api', `repos/{owner}/{repo}/commits/${input.commit}/pulls`], { cwd: input.cwd }));
-    }
-    catch (error) {
-        const message = error instanceof Error ? error.message : String(error);
-        throw new ValidationError(`Could not find the pull request of commit ${input.commit}: ${message}`);
-    }
-    const [pullRequest] = JSON.parse(stdout);
-    return pullRequest
-        ? {
-            number: pullRequest.number,
-            url: pullRequest.html_url,
-            author: pullRequest.user?.login ?? '',
-        }
-        : undefined;
-}