Merge pull request #526 from emberjs/release-plan

NullVoxPopuli · web-flow · commit e64a10ce1176 · 2026-02-02T12:06:42.000-05:00
start using release-plan
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -91,28 +91,3 @@ jobs:
       run: pnpm install --no-lockfile
     - name: test
       run: pnpm test
-
-  publish:
-    name: Publish to npm
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
-
-      - name: Install node
-        uses: actions/setup-node@v6
-        with:
-          node-version: 16
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: install dependencies
-        run: pnpm install
-
-      - name: auto-dist-tag
-        run: pnpm auto-dist-tag --write
-
-      - name: publish to npm
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
diff --git a/.github/workflows/plan-release.yml b/.github/workflows/plan-release.yml
@@ -0,0 +1,61 @@
+name: Plan Release
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - master
+  pull_request_target: # This workflow has permissions on the repo, do NOT run code from PRs in this workflow. See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+    types:
+      - labeled
+      - unlabeled
+
+concurrency:
+  group: plan-release # only the latest one of these should ever be running
+  cancel-in-progress: true
+
+jobs:
+  should-run-release-plan-prepare:
+    name: Should we run release-plan prepare?
+    runs-on: ubuntu-latest
+    outputs:
+      should-prepare: ${{ steps.should-prepare.outputs.should-prepare }}
+    steps:
+      - uses: release-plan/actions/should-prepare-release@v1
+        with:
+          ref: 'master'
+        id: should-prepare
+
+  create-prepare-release-pr:
+    name: Create Prepare Release PR
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: should-run-release-plan-prepare
+    permissions:
+      contents: write
+      issues: read
+      pull-requests: write
+    if: needs.should-run-release-plan-prepare.outputs.should-prepare == 'true'
+    steps:
+      - uses: release-plan/actions/prepare@v1
+        name: Run release-plan prepare
+        with:
+          ref: 'master'
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+        id: explanation
+
+      - uses: peter-evans/create-pull-request@v8
+        name: Create Prepare Release PR
+        with:
+          commit-message: "Prepare Release ${{ steps.explanation.outputs.new-version}} using 'release-plan'"
+          labels: "internal"
+          sign-commits: true
+          branch: release-preview
+          title: Prepare Release ${{ steps.explanation.outputs.new-version }}
+          body: |
+            This PR is a preview of the release that [release-plan](https://github.com/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍
+
+            -----------------------------------------
+
+            ${{ steps.explanation.outputs.text }}
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,41 @@
+# For every push to the primary branch with .release-plan.json modified,
+# runs release-plan.
+
+name: Publish Stable
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - '.release-plan.json'
+
+concurrency:
+  group: publish-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  publish:
+    name: "NPM Publish"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      attestations: write
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
+          cache: pnpm
+      - run: npm install -g npm@latest # ensure that the globally installed npm is new enough to support OIDC
+      - run: pnpm install --frozen-lockfile
+      - name: Publish to NPM
+        run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+# Changelog
+
 
 
 
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,65 +1,27 @@
-# Release
-
-Releases are mostly automated using
-[release-it](https://github.com/release-it/release-it/) and
-[lerna-changelog](https://github.com/lerna/lerna-changelog/).
+# Release Process
 
+Releases in this repo are mostly automated using [release-plan](https://github.com/embroider-build/release-plan/). Once you label all your PRs correctly (see below) you will have an automatically generated PR that updates your CHANGELOG.md file and a `.release-plan.json` that is used to prepare the release once the PR is merged.
 
 ## Preparation
 
-Since the majority of the actual release process is automated, the primary
-remaining task prior to releasing is confirming that all pull requests that
-have been merged since the last release have been labeled with the appropriate
-`lerna-changelog` labels and the titles have been updated to ensure they
-represent something that would make sense to our users. Some great information
-on why this is important can be found at
-[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
-guiding principles here is that changelogs are for humans, not machines.
-
-When reviewing merged PR's the labels to be used are:
-
-* breaking - Used when the PR is considered a breaking change.
-* enhancement - Used when the PR adds a new feature or enhancement.
-* bug - Used when the PR fixes a bug included in a previous release.
-* documentation - Used when the PR adds or updates documentation.
-* internal - Used for internal changes that still require a mention in the
-  changelog/release notes.
-
-
-## Release
+Since the majority of the actual release process is automated, the remaining tasks before releasing are:
 
-Once the prep work is completed, the actual release is straight forward:
+- correctly labeling **all** pull requests that have been merged since the last release
+- updating pull request titles so they make sense to our users
 
-* First ensure that you have `release-it` installed globally, generally done by
-  using one of the following commands:
+Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
+guiding principle here is that changelogs are for humans, not machines.
 
-```
-# using https://volta.sh
-volta install release-it
-
-# using Yarn
-yarn global add release-it
-
-# using npm
-npm install --global release-it
-```
-
-* Second, ensure that you have installed your projects dependencies:
-
-```
-# using yarn
-yarn install
+When reviewing merged PR's the labels to be used are:
 
-# using npm
-npm install
-```
+- breaking - Used when the PR is considered a breaking change.
+- enhancement - Used when the PR adds a new feature or enhancement.
+- bug - Used when the PR fixes a bug included in a previous release.
+- documentation - Used when the PR adds or updates documentation.
+- internal - Internal changes or things that don't fit in any other category.
 
-* And last (but not least 😁) do your release:
+**Note:** `release-plan` requires that **all** PRs are labeled. If a PR doesn't fit in a category it's fine to label it as `internal`
 
-```
-release-it
-```
+## Release
 
-[release-it](https://github.com/release-it/release-it/) manages the actual
-release process. It will prompt you through the process of choosing the version
-number, tagging, pushing the tag and commits, etc.
+Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/babel/ember-cli-babel/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR
diff --git a/package.json b/package.json
@@ -20,14 +20,14 @@
   },
   "license": "MIT",
   "author": "Gordon Kristan",
-  "files": [
-    "index.js",
-    "lib"
-  ],
   "directories": {
     "doc": "doc",
     "test": "tests"
   },
+  "files": [
+    "index.js",
+    "lib"
+  ],
   "scripts": {
     "build": "ember build",
     "lint:js": "eslint . --cache",
@@ -39,9 +39,6 @@
     "test:node": "mocha node-tests",
     "test:node:debug": "mocha debug node-tests"
   },
-  "peerDependencies": {
-    "@babel/core": "^7.12.0"
-  },
   "dependencies": {
     "@babel/helper-compilation-targets": "^7.20.7",
     "@babel/plugin-proposal-decorators": "^7.20.13",
@@ -78,7 +75,6 @@
     "@ember/test-helpers": "^3.2.0",
     "@glimmer/component": "^1.0.4",
     "@glimmer/tracking": "^1.0.4",
-    "@release-it-plugins/lerna-changelog": "^6.0.0",
     "babel-eslint": "^10.1.0",
     "broccoli-test-helper": "^2.0.0",
     "chai": "^4.3.7",
@@ -106,48 +102,25 @@
     "mocha": "^10.2.0",
     "qunit": "^2.19.4",
     "regenerator-runtime": "^0.14.0",
-    "release-it": "^16.1.5",
+    "release-plan": "^0.17.4",
     "resolve": "^1.22.4",
     "rimraf": "^5.0.1",
     "webpack": "^5.88.2"
   },
+  "peerDependencies": {
+    "@babel/core": "^7.12.0"
+  },
+  "packageManager": "pnpm@8.15.9",
   "engines": {
     "node": "16.* || 18.* || >= 20"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
-  "changelog": {
-    "repo": "babel/ember-cli-babel",
-    "labels": {
-      "breaking": ":boom: Breaking Change",
-      "enhancement": ":rocket: Enhancement",
-      "bug": ":bug: Bug Fix",
-      "documentation": ":memo: Documentation",
-      "internal": ":house: Internal"
-    }
-  },
   "ember": {
     "edition": "octane"
   },
   "ember-addon": {
     "configPath": "tests/dummy/config"
-  },
-  "release-it": {
-    "plugins": {
-      "@release-it-plugins/lerna-changelog": {
-        "infile": "CHANGELOG.md"
-      }
-    },
-    "git": {
-      "tagName": "v${version}"
-    },
-    "github": {
-      "release": true
-    },
-    "npm": {
-      "publish": false
-    }
-  },
-  "packageManager": "pnpm@8.15.9"
+  }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
