"publish: stash of uncommitted changes by release script"

Author: runspired

package.json

@@ -38,7 +38,6 @@
     "test-external:ember-data-relationship-tracker": "node ./scripts/test-external-partner-project.js ember-data-relationship-tracker https://github.com/ef4/ember-data-relationship-tracker.git"
   },
   "devDependencies": {
-    "@octokit/rest": "^20.0.2",
     "bun-types": "^1.0.25",
     "@types/semver": "^7.5.6",
     "chalk": "^4.1.2",

pnpm-lock.yaml

@@ -2,15 +2,32 @@ import chalk from 'chalk';
 import * as readline from 'readline/promises';
 
 export async function confirmStrategy() {
+  return confirm({
+    prompt: chalk.white(`\nDo you want to continue with this strategy?`),
+    cancelled: chalk.red('🚫 Strategy not confirmed. Exiting...'),
+  });
+}
+
+/**
+ * Prompt user to continue, exit if not confirmed.
+ *
+ * In CI environments, this function will return immediately without prompting.
+ *
+ * config.prompt - The prompt to display to the user
+ * config.cancelled - The message to display if the user cancels
+ *
+ * yes/no prompt will be added to the end of the prompt text automatically.
+ *
+ * @internal
+ */
+export async function confirm(config: { prompt: string; cancelled: string }): Promise<void> {
   if (process.env.CI) {
     return;
   }
-  const confirm = await question(
-    chalk.white(`\nDo you want to continue with this strategy? ${chalk.yellow(`[y/n]`)}: `)
-  );
+  const confirm = await question(`${config.prompt} ${chalk.yellow(`[y/n]`)}: `);
   const input = confirm.trim().toLowerCase();
   if (input !== 'y' && input !== 'yes') {
-    console.log(chalk.red('🚫 Strategy not confirmed. Exiting...'));
+    console.log(config.cancelled);
     process.exit(1);
   }
 }

release/core/publish/steps/confirm-strategy.ts

@@ -9,6 +9,7 @@ import { release_notes_flags_config } from '../../utils/flags-config';
 import { SEMVER_VERSION } from '../../utils/channel';
 import { updateChangelogs } from './steps/update-changelogs';
 import { getChanges } from './steps/get-changes';
+import { confirmCommitChangelogs } from './steps/confirm-changelogs';
 
 export async function executeReleaseNoteGeneration(args: string[]) {
   // remove the command itself from the list
@@ -50,5 +51,7 @@ export async function executeReleaseNoteGeneration(args: string[]) {
   // update all changelogs, including the primary changelog
   // and the changelogs for each package in changelogRoots
   // this will not commit the changes
-  await updateChangelogs(fromTag, newChanges, config.full, strategy, packages, applied);
+  const changedFiles = await updateChangelogs(fromTag, newChanges, config.full, strategy, packages, applied);
+
+  await confirmCommitChangelogs(changedFiles, config.full, packages);
 }

release/core/release-notes/index.ts

@@ -0,0 +1,43 @@
+import { BunFile } from 'bun';
+import { confirm } from '../../publish/steps/confirm-strategy';
+import { exec } from '../../../utils/cmd';
+import { Package } from '../../../utils/package';
+import { SEMVER_VERSION } from '../../../utils/channel';
+import chalk from 'chalk';
+
+export async function confirmCommitChangelogs(
+  _changedFiles: BunFile[],
+  config: Map<string, string | number | boolean | null>,
+  packages: Map<string, Package>
+) {
+  const dryRun = config.get('dry_run') as boolean;
+
+  if (config.get('commit') === false) {
+    console.log(chalk.grey(`\t➠ Skipped commit of changelogs.`));
+    return;
+  }
+
+  try {
+    await confirm({
+      prompt: `Do you want to commit the changelogs?`,
+      cancelled: `🚫 Commit of changelogs cancelled. Exiting...`,
+    });
+  } finally {
+    if (dryRun) {
+      // cleanup files because we're not actually committing
+      await exec(['sh', '-c', `git add -A && git reset --hard HEAD`]);
+    }
+  }
+
+  if (!dryRun) {
+    const newVersion = packages.get('root')!.pkgData.version as SEMVER_VERSION;
+    await exec(['sh', '-c', `git add -A && git commit -m "chore: update changelogs for v${newVersion}"`]);
+
+    if (config.get('upstream')) {
+      await exec(['sh', '-c', `git push`]);
+      console.log(chalk.grey(`\t✅ pushed changelog commit to upstream.`));
+    } else {
+      console.log(chalk.grey(`\t➠ Skipped push of changelogs.`));
+    }
+  }
+}

release/core/release-notes/steps/confirm-changelogs.ts

@@ -3,6 +3,7 @@ import { AppliedStrategy } from '../../publish/steps/generate-strategy';
 import { Committers, Entry, LernaChangeset } from './get-changes';
 import path from 'path';
 import chalk from 'chalk';
+import { BunFile } from 'bun';
 
 function findInsertionPoint(lines: string[], version: string) {
   for (let i = 0; i < lines.length; i++) {
@@ -72,7 +73,7 @@ export async function updateChangelogs(
   strategy: STRATEGY,
   packages: Map<string, Package>,
   applied: AppliedStrategy
-) {
+): Promise<BunFile[]> {
   const file = Bun.file('./CHANGELOG.md');
   const mainChangelog = await file.text();
   const lines = mainChangelog.split('\n');
@@ -83,6 +84,7 @@ export async function updateChangelogs(
   lines.splice(insertionPoint, 0, ...newLines);
   await Bun.write(file, lines.join('\n'));
   console.log(`\t✅ Updated Primary Changelog`);
+  const changedFiles = [file];
 
   for (const [pkgName, changes] of Object.entries(newChanges.byPackage)) {
     if (pkgName === 'root') {
@@ -100,6 +102,7 @@ export async function updateChangelogs(
     const fromVersion = applied.all.get(pkgName)!.fromVersion;
     const fromTag = `v${fromVersion}`;
     const newLines = buildText(toTag, strategy, changes, newChanges.data[Committers]);
+    changedFiles.push(changelogFile);
 
     let changelogLines: string[] = [];
     if (!exists) {
@@ -124,4 +127,6 @@ export async function updateChangelogs(
         : `\t✅ Created ${chalk.cyan(pkg.pkgData.name)} Changelog`
     );
   }
+
+  return changedFiles;
 }

release/core/release-notes/steps/update-changelogs.ts

@@ -185,8 +185,18 @@ export function merge<T>(...args: T[]): T {
 }
 
 export const release_notes_flags_config: FlagConfig = merge(
-  pick(publish_flags_config, ['help', 'increment', 'dry_run', 'dangerously_force', 'tag', 'channel']),
+  pick(publish_flags_config, ['help', 'increment', 'dry_run', 'dangerously_force', 'tag', 'channel', 'upstream']),
   {
+    commit: {
+      name: 'Commit',
+      flag: 'commit',
+      flag_aliases: ['c'],
+      flag_mispellings: ['cm', 'comit'],
+      description: 'Whether to commit the changes to the changelogs',
+      type: Boolean,
+      examples: [],
+      default_value: true,
+    },
     from: {
       name: 'From Version',
       flag: 'from',
@@ -214,16 +224,6 @@ export const release_notes_flags_config: FlagConfig = merge(
         }
       },
     },
-    pr: {
-      name: 'Open a Pull Request',
-      flag: 'pr',
-      flag_aliases: ['p'],
-      flag_mispellings: ['pullrequest', 'pull-request', 'issue', 'upstream', 'up', 'open'],
-      description: 'Whether to open a pull request with the release notes',
-      type: Boolean,
-      examples: [],
-      default_value: true,
-    },
   }
 );