Function formatReleasePlanComment

packages/bumpy/src/commands/ci.ts:1320–1451

(
  plan: ReleasePlan,
  bumpFiles: BumpFile[],
  prNumber: string,
  prBranch: string | null,
  pm: PackageManager,
  warnings: string[] = [],
  parseErrors: string[] = [],
  emptyBumpFileIds: string[] = [],
  channel: ResolvedChannel | null = null,
  allChannels: Map<string, ResolvedChannel> | null = null,
)

}

export function formatReleasePlanComment(
  plan: ReleasePlan,
  bumpFiles: BumpFile[],
  prNumber: string,
  prBranch: string | null,
  pm: PackageManager,
  warnings: string[] = [],
  parseErrors: string[] = [],
  emptyBumpFileIds: string[] = [],
  channel: ResolvedChannel | null = null,
  allChannels: Map<string, ResolvedChannel> | null = null,
): string {
  const repo = process.env.GITHUB_REPOSITORY;
  const lines: string[] = [];

  // When targeting a prerelease channel, the version display carries a wildcard
  // `-<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.`
    : 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>`,
    '',
    headline,
    '<br clear="left" />',
  ].join('\n');
  lines.push(preamble);
  lines.push('');

  // Package list grouped by bump type
  const groups: Record<string, PlannedRelease[]> = { major: [], minor: [], patch: [] };
  for (const r of plan.releases) {
    groups[r.type]?.push(r);
  }

  for (const type of ['major', 'minor', 'patch'] as const) {
    const releases = groups[type];
    if (!releases || releases.length === 0) continue;

    lines.push(bumpSectionHeader(type));
    lines.push('');
    for (const r of releases) {
      const suffix = r.isDependencyBump ? ' _(dep)_' : r.isCascadeBump ? ' _(cascade)_' : '';
      lines.push(`- \`${r.name}\` ${r.oldVersion} → **${r.newVersion}${versionSuffix}**${suffix}`);
    }
    lines.push('');
  }