Add release workflow (#2191)

Author: ddbeck

.github/workflows/prepare_release.yml

@@ -0,0 +1,36 @@
+name: Prepare web-features release
+
+on:
+  workflow_dispatch:
+    inputs:
+      semverLevel:
+        description: "Bump to semver level"
+        required: true
+        type: choice
+        default: "minor"
+        options:
+          - patch
+          - minor
+          - major
+
+jobs:
+  open_pr:
+    name: Open PR
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+          cache: npm
+      - run: npm ci
+      - name: ./scripts/release.ts init
+        run: npx tsx ./scripts/release.ts init --target-repo=$REPO --reviewers=$ACTOR $SEMVER_LEVEL
+        env:
+          ACTOR: ${{ github.actor }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO: ${{ github.repository }}
+          SEMVER_LEVEL: ${{ inputs.semverLevel }}

scripts/release-pull-description.md

@@ -1 +1 @@
-⚠ Caution! Merging this PR triggers a release. Continue reading before merging. ⚠
+This is a generated release pull request. Don't merge if you're not ready to carry out the release.

scripts/release.ts

@@ -62,6 +62,10 @@ yargs(process.argv.slice(2))
           choices: semverChoices,
           default: "patch",
         })
+        .option("reviewers", {
+          describe: "Comma-separated list of users to request reviews from",
+          nargs: 1,
+        })
         .demandOption("semverlevel", "You must provide a semver level");
     },
     handler: init,
@@ -87,6 +91,10 @@ function init(args) {
   logger.debug(checkoutCmd);
   execSync(checkoutCmd);
 
+  const { version: previousVersion } = readPackageJSON(
+    packages["web-features"],
+  );
+
   // Bump version (no tag)
   const newVersion = bumpVersion(args.semverlevel);
 
@@ -98,13 +106,13 @@ function init(args) {
   // Create PR
   const title = [pullTitleBase, newVersion].join("");
   logger.info(`Creating PR: ${title}`);
-  const reviewer = "ddbeck";
-  const body = makePullBody(diff);
+  const reviewers = args.reviewers.split(",");
+  const body = makePullBody(newVersion, previousVersion);
 
   const pullRequestCmd = [
     "gh pr create",
     `--title="${title}"`,
-    `--reviewer="${reviewer}"`,
+    ...reviewers.map((r) => `--reviewer=${r}`),
     `--body-file=-`,
     `--base="main"`,
     `--head="${releaseBranch}"`,
@@ -132,15 +140,31 @@ function bumpVersion(semverlevel: typeof semverChoices): string {
   return version;
 }
 
-function makePullBody(diff: string) {
+function makePullBody(newVersion: string, previousVersion: string) {
+  // https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release
+  const relnotesCmd = [
+    "gh",
+    "api",
+    "--method POST",
+    `-H "Accept: application/vnd.github+json"`,
+    `-H "X-GitHub-Api-Version: 2022-11-28"`,
+    "/repos/{owner}/{repo}/releases/generate-notes",
+    `-f "tag_name=v${newVersion}"`,
+    `-f "target_commitish=main"`,
+    `-f "previous_tag_name=v${previousVersion}"`,
+  ].join(" ");
+  const relNotes = execSync(relnotesCmd, {
+    cwd: packages["web-features"],
+    encoding: "utf-8",
+  });
+  const relNotesLines = JSON.parse(relNotes).body.split("\n");
+
   const bodyFile = fileURLToPath(
     new URL("release-pull-description.md", import.meta.url),
   );
   const body = [
     readFileSync(bodyFile, { encoding: "utf-8" }),
-    "```diff",
-    diff,
-    "```",
+    ...relNotesLines,
   ].join("\n");
   return body;
 }