feat: explicit promotion callout in PR check comment (#113)

Follow-up from [#110](#110
comment looking identical to an ordinary feature PR's. A promotion PR is
the highest-stakes merge in the channel flow — it ends the cycle,
consolidates the changelog, and ships to `@latest` — so the comment now
says so.

**Detection:** stable-targeted PR (no channel match on the base)
carrying bump files with `channel` set. Covers the canonical `next` →
`main` PR and partial promotions from branches cut off a channel.
Channel-targeted PRs keep their existing banner.

**Headline** becomes:

> **This PR promotes the `next` prerelease cycle to a stable release.**
The changes below that already shipped to the `@next` dist-tag will be
consolidated into the next stable version bump.

**File list** annotates shipped files, so mixed PRs (shipped cycle +
never-rc'd fixes) read at a glance:

> - `next/prerelease-channels.md` _(shipped on `@next`)_
> - `ci-check-channel-bump-files.md`

The shipped annotation also appears on graduation PRs (e.g.
`.bumpy/alpha/` files on a beta-targeted PR), where it's equally
accurate.

297 tests pass. Once merged, #110's comment should update itself with
the promotion callout (next moves forward → synchronize → check-local
rebuilds).

Author: theoephraim

.bumpy/promotion-pr-comment.md

@@ -0,0 +1,5 @@
+---
+'@varlock/bumpy': patch
+---
+
+The PR check comment now explicitly calls out promotion PRs (channel → stable): the headline explains that merging ends the prerelease cycle and ships stable, and bump files that already shipped on a channel are annotated with their dist-tag (e.g. `next/feature.md` _(shipped on `@next`)_).

packages/bumpy/src/commands/ci.ts

@@ -108,9 +108,10 @@ export async function ciCheckCommand(rootDir: string, opts: CheckOptions): Promi
   // Skip on the version PR branch (and channel release PR branches) — they move/consume
   // bump files by design
   const prBranchName = detectPrBranch(rootDir);
+  const channels = resolveChannels(config);
   const releasePrBranches = new Set([
     config.versionPr.branch,
-    ...[...resolveChannels(config).values()].map((c) => c.versionPr.branch),
+    ...[...channels.values()].map((c) => c.versionPr.branch),
   ]);
   if (prBranchName && releasePrBranches.has(prBranchName)) {
     log.dim('  Skipping — this is a release PR branch.');
@@ -228,6 +229,7 @@ export async function ciCheckCommand(rootDir: string, opts: CheckOptions): Promi
       parseErrors,
       emptyBumpFileIds,
       prChannel,
+      channels,
     );
     await postOrUpdatePrComment(prNumber, comment, rootDir);
   }
@@ -1024,6 +1026,7 @@ export function formatReleasePlanComment(
   parseErrors: string[] = [],
   emptyBumpFileIds: string[] = [],
   channel: ResolvedChannel | null = null,
+  allChannels: Map<string, ResolvedChannel> | null = null,
 ): string {
   const repo = process.env.GITHUB_REPOSITORY;
   const lines: string[] = [];
@@ -1032,9 +1035,17 @@ export function formatReleasePlanComment(
   // `-<preid>.x` suffix (the exact counter is derived from the registry at publish time).
   const versionSuffix = channel ? `-${channel.preid}.x` : '';
 
+  // Promotion PR: stable-targeted, carrying bump files that already shipped on a
+  // channel (e.g. `next` → `main`). Merging it ends the cycle and ships stable.
+  const promotedChannels = channel ? [] : [...new Set(bumpFiles.map((bf) => bf.channel))].filter((c) => c != null);
+  const channelTag = (name: string) => `\`@${allChannels?.get(name)?.tag ?? name}\``;
+
   const headline = channel
     ? `**This PR targets the \`${channel.name}\` prerelease channel** — merging it ships these packages as a **prerelease** to the \`@${channel.tag}\` dist-tag, not a stable release.`
-    : '**The changes in this PR will be included in the next version bump.**';
+    : promotedChannels.length > 0
+      ? `**This PR promotes the ${promotedChannels.map((c) => `\`${c}\``).join(', ')} prerelease cycle${promotedChannels.length > 1 ? 's' : ''} to a stable release.** ` +
+        `The changes below that already shipped to the ${promotedChannels.map(channelTag).join(', ')} dist-tag${promotedChannels.length > 1 ? 's' : ''} will be consolidated into the next stable version bump.`
+      : '**The changes in this PR will be included in the next version bump.**';
   const preamble = [
     `<a href="https://bumpy.varlock.dev"><img src="${FROG_IMG_BASE}/frog-clipboard.png" alt="bumpy-frog" width="60" align="left" style="image-rendering: pixelated;" title="Hi! I'm bumpy!" /></a>`,
     '',
@@ -1082,6 +1093,7 @@ export function formatReleasePlanComment(
     // Channel-dir files (pending on promotion/graduation PRs) live at `.bumpy/<channel>/`
     const filename = bf.channel ? `${bf.channel}/${bf.id}.md` : `${bf.id}.md`;
     const parts: string[] = [`\`${filename}\``];
+    if (bf.channel) parts.push(`_(shipped on ${channelTag(bf.channel)})_`);
     if (repo) {
       parts.push(
         `([view diff](https://github.com/${repo}/pull/${prNumber}/changes#diff-${sha256Hex(`.bumpy/${filename}`)}))`,

packages/bumpy/test/core/ci-channel-comment.test.ts

@@ -3,9 +3,8 @@ import { formatReleasePlanComment } from '../../src/commands/ci.ts';
 import { resolveChannels } from '../../src/core/channels.ts';
 import { makeRelease, makeReleasePlan, makeBumpFile, makeConfig } from '../helpers.ts';
 
-const channel = resolveChannels(makeConfig({ channels: { next: { branch: 'next', preid: 'rc', tag: 'next' } } })).get(
-  'next',
-)!;
+const allChannels = resolveChannels(makeConfig({ channels: { next: { branch: 'next', preid: 'rc', tag: 'next' } } }));
+const channel = allChannels.get('next')!;
 
 const plan = makeReleasePlan(
   [makeRelease('@myorg/core', '1.2.0', { type: 'minor', oldVersion: '1.1.0', bumpFiles: ['feat'] })],
@@ -51,14 +50,54 @@ describe('formatReleasePlanComment — promotion PR (channel-dir bump files, sta
     [makeRelease('@myorg/core', '1.2.0', { type: 'minor', oldVersion: '1.1.0', bumpFiles: ['feat'] })],
     [{ ...makeBumpFile('feat', [{ name: '@myorg/core', type: 'minor' }], 'Add a feature'), channel: 'next' }],
   );
-  const comment = formatReleasePlanComment(promotionPlan, promotionPlan.bumpFiles, '1', 'next', 'npm');
+  const comment = formatReleasePlanComment(
+    promotionPlan,
+    promotionPlan.bumpFiles,
+    '1',
+    'next',
+    'npm',
+    [],
+    [],
+    [],
+    null,
+    allChannels,
+  );
+
+  test('headline calls out the promotion explicitly', () => {
+    expect(comment).toContain('promotes the `next` prerelease cycle to a stable release');
+    expect(comment).toContain('already shipped to the `@next` dist-tag');
+    expect(comment).not.toContain('included in the next version bump');
+  });
 
-  test('renders channel-dir bump files with their subdir path', () => {
-    expect(comment).toContain('`next/feat.md`');
+  test('renders channel-dir bump files with their subdir path and shipped annotation', () => {
+    expect(comment).toContain('`next/feat.md` _(shipped on `@next`)_');
   });
 
   test('shows the stable plan (no channel banner, no preid suffix)', () => {
     expect(comment).toContain('1.1.0 → **1.2.0**');
     expect(comment).not.toContain('prerelease channel');
   });
+
+  test('mixed promotion: root bump files get no shipped annotation', () => {
+    const mixedPlan = makeReleasePlan(promotionPlan.releases, [
+      ...promotionPlan.bumpFiles,
+      makeBumpFile('new-fix', [{ name: '@myorg/core', type: 'patch' }], 'A fix that never shipped as an rc'),
+    ]);
+    const mixed = formatReleasePlanComment(
+      mixedPlan,
+      mixedPlan.bumpFiles,
+      '1',
+      'next',
+      'npm',
+      [],
+      [],
+      [],
+      null,
+      allChannels,
+    );
+    expect(mixed).toContain('promotes the `next` prerelease cycle');
+    expect(mixed).toContain('`next/feat.md` _(shipped on `@next`)_');
+    expect(mixed).toContain('- `new-fix.md`');
+    expect(mixed).not.toContain('`new-fix.md` _(shipped');
+  });
 });