versionary 0.13.0 → 0.14.1

package/README.md

@@ -144,6 +144,10 @@ For a quick trial, use:
   request)
 - `release-draft` (default `false`) publishes GitHub releases as drafts when
   enabled
+- `release-reference-comments` controls release comments on linked issues/PRs:
+  - `off` (default): do not post comments
+  - `best-effort`: post comments and continue on API/permission failures
+  - `strict`: fail release if comment posting fails
 - optional monorepo planning with `monorepo-mode` and `packages`:
   - `independent` computes package bumps per path
   - `fixed` computes one shared bump across configured package paths

package/dist/config/schema.d.ts

@@ -14,6 +14,11 @@ export declare const configSchema: z.ZodObject<{
         "r-news": "r-news";
     }>>;
     "release-draft": z.ZodOptional<z.ZodBoolean>;
+    "release-reference-comments": z.ZodOptional<z.ZodEnum<{
+        off: "off";
+        "best-effort": "best-effort";
+        strict: "strict";
+    }>>;
     "release-branch": z.ZodOptional<z.ZodString>;
     "baseline-file": z.ZodOptional<z.ZodString>;
     "bootstrap-sha": z.ZodOptional<z.ZodString>;

package/dist/config/schema.js

@@ -68,6 +68,9 @@ exports.configSchema = zod_1.z
     "changelog-file": zod_1.z.string().optional(),
     "changelog-format": zod_1.z.enum(["markdown-changelog", "r-news"]).optional(),
     "release-draft": zod_1.z.boolean().optional(),
+    "release-reference-comments": zod_1.z
+        .enum(["off", "best-effort", "strict"])
+        .optional(),
     "release-branch": zod_1.z.string().optional(),
     "baseline-file": zod_1.z.string().optional(),
     "bootstrap-sha": zod_1.z.string().optional(),

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { verifyProject } from "./release/verify-project.js";
 export { findPluginsByCapability, pluginHasCapability, } from "./scm/capabilities.js";
 export { getScmClient } from "./scm/client.js";
 export { createGitHubPlugin } from "./scm/github-plugin.js";
-export type { ScmClient, ScmClientContext, ScmProvider, ScmReleaseMetadataInput, ScmReleaseMetadataResult, ScmReviewRequestInput, ScmReviewRequestResult, } from "./scm/types.js";
+export type { ScmClient, ScmClientContext, ScmProvider, ScmReleaseMetadataInput, ScmReleaseMetadataResult, ScmReleaseReferenceCommentsInput, ScmReleaseReferenceCommentsResult, ScmReviewRequestInput, ScmReviewRequestResult, } from "./scm/types.js";
 export { resolveVersionStrategy } from "./strategy/resolve.js";
 export type { VersionaryArtifactRule, VersionaryConfig, VersionaryPackage, } from "./types/config.js";
-export type { VersionaryPluginCapability, VersionaryPluginContext, VersionaryPluginRuntime, VersionaryScmReleaseMetadataInput, VersionaryScmReleaseMetadataResult, VersionaryScmReviewRequestInput, VersionaryScmReviewRequestResult, } from "./types/plugins.js";
+export type { VersionaryPluginCapability, VersionaryPluginContext, VersionaryPluginRuntime, VersionaryScmReleaseMetadataInput, VersionaryScmReleaseMetadataResult, VersionaryScmReleaseReferenceCommentsInput, VersionaryScmReleaseReferenceCommentsResult, VersionaryScmReviewRequestInput, VersionaryScmReviewRequestResult, } from "./types/plugins.js";

package/dist/release/changelog.js

@@ -51,6 +51,28 @@ function groupCommitLines(commits, repoUrl) {
     const features = [];
     const fixes = [];
     const reverts = [];
+    const getRevertedSubject = (commit) => {
+        const normalizedDescription = (commit.description ?? "")
+            .trim()
+            .replace(/^"(.*)"$/u, "$1");
+        if (normalizedDescription.length > 0) {
+            return normalizedDescription;
+        }
+        const quoted = commit.subject.match(/^revert:\s+"(.+)"$/iu);
+        if (quoted) {
+            return quoted[1].trim();
+        }
+        const plain = commit.subject.match(/^revert:\s+(.+)$/iu);
+        return plain ? plain[1].trim() : "";
+    };
+    const shouldIncludeRevert = (commit) => {
+        const revertedSubject = getRevertedSubject(commit);
+        if (revertedSubject.length === 0) {
+            return true;
+        }
+        const revertedCommit = (0, commits_js_1.parseConventionalCommitMessage)(revertedSubject);
+        return (0, commits_js_1.inferReleaseTypeFromParsedCommit)(revertedCommit) !== null;
+    };
     for (const commit of commits) {
         const type = (0, commits_js_1.inferReleaseTypeFromParsedCommit)(commit);
         if (!type) {
@@ -67,6 +89,9 @@ function groupCommitLines(commits, repoUrl) {
         const commitType = (commit.type ?? "").toLowerCase();
         const isBreaking = type === "major";
         if (commit.isRevert) {
+            if (!shouldIncludeRevert(commit)) {
+                continue;
+            }
             reverts.push(line);
             continue;
         }
@@ -130,18 +155,21 @@ function renderReleasePlanChangelog(plan) {
             version: pkg.nextVersion,
         }))
         : [];
+    const dedupedCommits = [
+        ...new Map(plan.commits.map((commit) => [commit.hash, commit])).values(),
+    ];
     if (plan.changelogFormat === "r-news") {
         return renderRNewsReleaseNotes({
             packageName: plan.packageName,
             nextVersion: plan.nextVersion,
-            commits: plan.commits,
+            commits: dedupedCommits,
             cwd: process.cwd(),
         });
     }
     return renderSimpleReleaseNotes({
         currentVersion: plan.currentVersion,
         nextVersion: plan.nextVersion,
-        commits: plan.commits,
+        commits: dedupedCommits,
         cwd: process.cwd(),
         dependencies,
     });

package/dist/release/release.d.ts

@@ -1,6 +1,7 @@
 import type { VersionaryConfig } from "../types/config.js";
 import type { VersionaryPluginContext } from "../types/plugins.js";
 export declare function extractReleaseNotes(content: string, version: string, changelogFormat: "markdown-changelog" | "r-news"): string;
+export declare function extractClosingReferencesFromNotes(notes: string): number[];
 export declare function resolveTargetChangelogFile(config: VersionaryConfig, rootChangelogFile: string, targetPath: string): string;
 export declare function runRelease(cwd?: string): Promise<string>;
 export type RunReleaseResult = {

package/dist/release/release.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractReleaseNotes = extractReleaseNotes;
+exports.extractClosingReferencesFromNotes = extractClosingReferencesFromNotes;
 exports.resolveTargetChangelogFile = resolveTargetChangelogFile;
 exports.runRelease = runRelease;
 exports.runReleaseDetailed = runReleaseDetailed;
@@ -75,6 +76,24 @@ function readReleaseNotes(cwd, version, changelogFile, changelogFormat) {
     const notes = extractReleaseNotes(content, version, changelogFormat);
     return notes.length > 0 ? notes : `Automated release for v${version}`;
 }
+function extractClosingReferencesFromNotes(notes) {
+    const refs = new Set();
+    const linkedPattern = /\b(close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved)\b\s+\[#(\d+)\]\([^)]+\)/giu;
+    for (const match of notes.matchAll(linkedPattern)) {
+        const issue = Number(match[2] ?? "");
+        if (Number.isInteger(issue) && issue > 0) {
+            refs.add(issue);
+        }
+    }
+    const plainPattern = /\b(close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved)\b\s+#(\d+)/giu;
+    for (const match of notes.matchAll(plainPattern)) {
+        const issue = Number(match[2] ?? "");
+        if (Number.isInteger(issue) && issue > 0) {
+            refs.add(issue);
+        }
+    }
+    return [...refs].sort((a, b) => a - b);
+}
 function resolveTargetChangelogFile(config, rootChangelogFile, targetPath) {
     if (targetPath === ".") {
         return rootChangelogFile;
@@ -114,6 +133,7 @@ async function runReleaseDetailed(cwd = process.cwd(), options = {}) {
     const loaded = (0, load_config_js_1.loadConfig)(cwd);
     const strategy = (0, resolve_js_1.resolveVersionStrategy)(loaded.config);
     const { changelogFile } = (0, plan_js_1.getChangelogDefaults)(loaded.config);
+    const referenceCommentMode = loaded.config["release-reference-comments"] ?? "off";
     const version = strategy.readVersion(cwd, loaded.config);
     const defaultTag = `v${version}`;
     const releaseTargets = (0, state_js_1.readReleaseTargets)(cwd);
@@ -139,13 +159,16 @@ async function runReleaseDetailed(cwd = process.cwd(), options = {}) {
     }
     const scmClient = (0, client_js_1.getScmClient)();
     const releases = [];
+    const referencesByTag = new Map();
     for (const target of targets) {
         const targetChangelogFile = resolveTargetChangelogFile(loaded.config, changelogFile, target.path);
         const targetChangelogFormat = resolveTargetChangelogFormat(loaded.config, target.path);
+        const releaseNotes = readReleaseNotes(cwd, target.version, targetChangelogFile, targetChangelogFormat);
+        referencesByTag.set(target.tag, extractClosingReferencesFromNotes(releaseNotes));
         const outcome = await (0, recovery_js_1.executeIdempotentReleaseTarget)(cwd, {
             tag: target.tag,
             version: target.version,
-            notes: readReleaseNotes(cwd, target.version, targetChangelogFile, targetChangelogFormat),
+            notes: releaseNotes,
             draft: loaded.config["release-draft"] ?? false,
         }, {
             createReleaseMetadata: (input) => scmClient.createReleaseMetadata(input, {
@@ -160,6 +183,20 @@ async function runReleaseDetailed(cwd = process.cwd(), options = {}) {
             tagStatus: outcome.tagStatus,
             metadataStatus: outcome.metadataStatus,
         });
+        const references = referencesByTag.get(outcome.tag) ?? [];
+        if (references.length > 0 &&
+            referenceCommentMode !== "off" &&
+            scmClient.createReleaseReferenceComments) {
+            await scmClient.createReleaseReferenceComments({
+                version: target.version,
+                releaseUrl: outcome.url,
+                references,
+                mode: referenceCommentMode,
+            }, {
+                cwd,
+                logger: options.logger,
+            });
+        }
     }
     const published = releases.map((outcome) => `${outcome.tag}: ${outcome.url} (tag=${outcome.tagStatus}, metadata=${outcome.metadataStatus})`);
     return {

package/dist/scm/github-plugin.js

@@ -89,7 +89,11 @@ async function ensureLabels(octokit, repo, pullNumber, labels, branchContext) {
 function createGitHubPlugin() {
     return {
         name: "github",
-        capabilities: ["scm.reviewRequest", "scm.releaseMetadata"],
+        capabilities: [
+            "scm.reviewRequest",
+            "scm.releaseMetadata",
+            "scm.releaseReferenceComments",
+        ],
         provider: "github",
         async createOrUpdateReviewRequest(input, _context) {
             const repo = getRepoFromEnv();
@@ -205,5 +209,38 @@ function createGitHubPlugin() {
             }
             return { url: data.html_url, status: "created" };
         },
+        async createReleaseReferenceComments(input, context) {
+            const repo = getRepoFromEnv();
+            const octokit = new rest_1.Octokit({ auth: getGitHubToken() });
+            const uniqueReferences = [...new Set(input.references)].sort((a, b) => a - b);
+            const commented = [];
+            const mode = input.mode ?? "best-effort";
+            for (const reference of uniqueReferences) {
+                const body = reference >= 1_000_000_000
+                    ? `This pull request is included in [version ${input.version}](${input.releaseUrl}).`
+                    : `This issue has been resolved in [version ${input.version}](${input.releaseUrl}).`;
+                try {
+                    await octokit.issues.createComment({
+                        owner: repo.owner,
+                        repo: repo.repo,
+                        issue_number: reference,
+                        body,
+                    });
+                    commented.push(reference);
+                }
+                catch (error) {
+                    const { status, message } = parseGitHubError(error);
+                    if (mode === "strict") {
+                        throw new Error(`Failed creating release reference comment on #${reference}: [${repoRef(repo)}] ${message}`);
+                    }
+                    if (status === 404 || status === 410 || status === 403) {
+                        context.logger?.warn(`Skipping release reference comment on #${reference}: [${repoRef(repo)}] ${message}`);
+                        continue;
+                    }
+                    context.logger?.warn(`Skipping release reference comment on #${reference}: [${repoRef(repo)}] ${message}`);
+                }
+            }
+            return { commented };
+        },
     };
 }

package/dist/scm/types.d.ts

@@ -30,8 +30,18 @@ export interface ScmReleaseMetadataResult {
     url: string;
     status?: "created" | "exists";
 }
+export interface ScmReleaseReferenceCommentsInput {
+    version: string;
+    releaseUrl: string;
+    references: number[];
+    mode?: "best-effort" | "strict";
+}
+export interface ScmReleaseReferenceCommentsResult {
+    commented: number[];
+}
 export interface ScmClient {
     provider: ScmProvider;
     createOrUpdateReviewRequest: (input: ScmReviewRequestInput, context: ScmClientContext) => Promise<ScmReviewRequestResult>;
     createReleaseMetadata: (input: ScmReleaseMetadataInput, context: ScmClientContext) => Promise<ScmReleaseMetadataResult>;
+    createReleaseReferenceComments?: (input: ScmReleaseReferenceCommentsInput, context: ScmClientContext) => Promise<ScmReleaseReferenceCommentsResult>;
 }

package/dist/types/config.d.ts

@@ -1,5 +1,6 @@
 export type ConfigFileFormat = "jsonc" | "json" | "toml" | "js";
 export type VersionaryChangelogFormat = "markdown-changelog" | "r-news";
+export type ReleaseReferenceCommentsMode = "off" | "best-effort" | "strict";
 export interface VersionaryArtifactRule {
     type: "json" | "toml" | "yaml" | "regex";
     path: string;
@@ -22,6 +23,7 @@ export interface VersionaryConfig {
     "changelog-file"?: string;
     "changelog-format"?: VersionaryChangelogFormat;
     "release-draft"?: boolean;
+    "release-reference-comments"?: ReleaseReferenceCommentsMode;
     "release-branch"?: string;
     "baseline-file"?: string;
     "bootstrap-sha"?: string;

package/dist/types/plugins.d.ts

@@ -1,9 +1,11 @@
-import type { ScmClientContext, ScmProvider, ScmReleaseMetadataInput, ScmReleaseMetadataResult, ScmReviewRequestInput, ScmReviewRequestResult } from "../scm/types.js";
-export type VersionaryPluginCapability = "scm.reviewRequest" | "scm.releaseMetadata";
+import type { ScmClientContext, ScmProvider, ScmReleaseMetadataInput, ScmReleaseMetadataResult, ScmReleaseReferenceCommentsInput, ScmReleaseReferenceCommentsResult, ScmReviewRequestInput, ScmReviewRequestResult } from "../scm/types.js";
+export type VersionaryPluginCapability = "scm.reviewRequest" | "scm.releaseMetadata" | "scm.releaseReferenceComments";
 export type VersionaryScmReviewRequestInput = ScmReviewRequestInput;
 export type VersionaryScmReviewRequestResult = ScmReviewRequestResult;
 export type VersionaryScmReleaseMetadataInput = ScmReleaseMetadataInput;
 export type VersionaryScmReleaseMetadataResult = ScmReleaseMetadataResult;
+export type VersionaryScmReleaseReferenceCommentsInput = ScmReleaseReferenceCommentsInput;
+export type VersionaryScmReleaseReferenceCommentsResult = ScmReleaseReferenceCommentsResult;
 export type VersionaryPluginContext = ScmClientContext;
 export interface VersionaryPluginRuntime {
     name: string;
@@ -11,4 +13,5 @@ export interface VersionaryPluginRuntime {
     provider?: ScmProvider;
     createOrUpdateReviewRequest?: (input: VersionaryScmReviewRequestInput, context: VersionaryPluginContext) => Promise<VersionaryScmReviewRequestResult>;
     createReleaseMetadata?: (input: VersionaryScmReleaseMetadataInput, context: VersionaryPluginContext) => Promise<VersionaryScmReleaseMetadataResult>;
+    createReleaseReferenceComments?: (input: VersionaryScmReleaseReferenceCommentsInput, context: VersionaryPluginContext) => Promise<VersionaryScmReleaseReferenceCommentsResult>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "versionary",
-  "version": "0.13.0",
+  "version": "0.14.1",
   "description": "Automatic release framework based on conventional commits and semantic versioning",
   "keywords": [
     "releasing",