@wpelevator/wp-release 0.6.1 → 0.8.0

package/dist/summary.d.ts

@@ -1,6 +1,8 @@
 import type { ChecksumsResult } from './commands/checksums.ts';
 import type { SignResult } from './commands/sign.ts';
 import type { ZipResult } from './commands/zip.ts';
+import type { ChangesetTagResult } from './changeset-release.ts';
+import type { PackageRelease } from './changesets.ts';
 import type { DeployOptions } from './deploy-options.ts';
 import type { SvnStatusEntry } from './svn.ts';
 import type { Problem } from './errors.ts';
@@ -105,6 +107,28 @@ export declare function getVerifySummary(context: SummaryContext, result: {
     checksumsPath: string;
     matched: number;
 }): string;
+/**
+ * Get the summary of applied or, in a dry run, pending package releases.
+ *
+ * @param releases Package releases.
+ * @param dryRun   Whether the versions were only planned.
+ * @return Markdown summary.
+ */
+export declare function getChangesetVersionSummary(releases: PackageRelease[], dryRun: boolean): string;
+/**
+ * Get the status of a release tag.
+ *
+ * @param item Tag of the changeset-tag result.
+ * @return Created, Exists or, in a dry run, Would create.
+ */
+export declare function getTagStatus(item: ChangesetTagResult['tags'][number]): string;
+/**
+ * Get the summary of release tags with their release notes.
+ *
+ * @param result Result of changeset-tag.
+ * @return Markdown summary.
+ */
+export declare function getChangesetTagSummary(result: ChangesetTagResult): string;
 /**
  * Get the summary of a version check without mismatches.
  *
@@ -139,3 +163,30 @@ export declare function getErrorSummary(title: string, message: string): string;
  * @return Markdown summary.
  */
 export declare function getDeploySummary(input: DeploySummaryInput): string;
+export interface GitDeploySummaryInput {
+    /** Repository URL, shown without credentials. */
+    gitUrl: string;
+    /** Release commit. */
+    revision: string;
+    /** Previous release. */
+    previous: string | null;
+    /** Whether a new release commit was created. */
+    created: boolean;
+    /** Whether the branch already has newer source history and isn't moved. */
+    outdated: boolean;
+    /** Refs to write, pushed unless it's a dry run. */
+    planned: string[];
+    /** Number of released files. */
+    files: number;
+    /** Whether the push was skipped. */
+    dryRun: boolean;
+}
+/**
+ * Get the summary of a Git deploy, with the release commit and the pushed
+ * refs.
+ *
+ * @param context Workspace directory.
+ * @param input   Git deploy result.
+ * @return Markdown summary.
+ */
+export declare function getGitDeploySummary(context: SummaryContext, input: GitDeploySummaryInput): string;

package/dist/summary.js

@@ -1,5 +1,6 @@
 import { isAbsolute, relative, resolve, sep } from 'node:path';
 import { normalizeTag } from "./deploy-options.js";
+import { redactUrls } from "./git.js";
 /**
  * SVN host of the WordPress.org plugin repositories.
  */
@@ -163,6 +164,56 @@ export function getVerifySummary(context, result) {
         `All ${result.matched} files match ${formatFile(context, result.checksumsPath)}.`,
     ]);
 }
+/**
+ * Get the summary of applied or, in a dry run, pending package releases.
+ *
+ * @param releases Package releases.
+ * @param dryRun   Whether the versions were only planned.
+ * @return Markdown summary.
+ */
+export function getChangesetVersionSummary(releases, dryRun) {
+    return joinBlocks([
+        dryRun ? '### Package releases (dry run)' : '### Package releases',
+        releases.length
+            ? formatTable(['Package', 'Version', 'Bump'], releases.map((release) => [
+                formatCode(release.package.name),
+                `${release.currentVersion} → ${release.nextVersion}`,
+                release.bump,
+            ]))
+            : 'No pending package releases.',
+    ]);
+}
+/**
+ * Get the status of a release tag.
+ *
+ * @param item Tag of the changeset-tag result.
+ * @return Created, Exists or, in a dry run, Would create.
+ */
+export function getTagStatus(item) {
+    if (item.created) {
+        return 'Created';
+    }
+    return item.exists ? 'Exists' : 'Would create';
+}
+/**
+ * Get the summary of release tags with their release notes.
+ *
+ * @param result Result of changeset-tag.
+ * @return Markdown summary.
+ */
+export function getChangesetTagSummary(result) {
+    return joinBlocks([
+        '### Release tags',
+        result.tags.length
+            ? formatTable(['Tag', 'Previous tag', 'Status'], result.tags.map((item) => [
+                formatCode(item.tag),
+                item.previousTag ? formatCode(item.previousTag) : '—',
+                getTagStatus(item),
+            ]))
+            : 'No packages to tag.',
+        ...result.tags.map((item) => formatDetails(`Release notes of ${formatCode(item.tag)}`, item.notes || 'No release notes.')),
+    ]);
+}
 /**
  * Get the summary of a version check without mismatches.
  *
@@ -285,3 +336,30 @@ export function getDeploySummary(input) {
                     : '')),
     ]);
 }
+/**
+ * Get the summary of a Git deploy, with the release commit and the pushed
+ * refs.
+ *
+ * @param context Workspace directory.
+ * @param input   Git deploy result.
+ * @return Markdown summary.
+ */
+export function getGitDeploySummary(context, input) {
+    const { revision, created, outdated, planned, files, dryRun } = input;
+    const refs = planned.map(formatCode).join(', ');
+    const pushedText = dryRun ? `Dry run, skipped pushing ${refs}.` : refs;
+    const reused = outdated
+        ? 'the previous release'
+        : 'the same files as the previous release';
+    return joinBlocks([
+        '### Deploy to Git',
+        formatList([
+            `**Repository:** ${formatCode(redactUrls(input.gitUrl))}`,
+            `**Release:** ${formatCode(revision)}, ${created ? `${files} files` : reused}`,
+            `**Pushed:** ${planned.length ? pushedText : 'nothing, no changes'}`,
+            outdated
+                ? '**Branch:** not moved, the previous release has newer source history'
+                : '',
+        ].filter(Boolean)),
+    ]);
+}

package/package.json

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