Merge pull request #1700 from embroider-build/merge-stable

Merge stable into main

.github/workflows/publish-stable.yml

@@ -10,9 +10,6 @@ on:
     branches:
       - main
 
-env:
-  VOLTA_FEATURE_PNPM: 1
-
 concurrency:
   group: publish-stable-${{ github.head_ref || github.ref }}
   cancel-in-progress: true
@@ -25,7 +22,7 @@ jobs:
       command: ${{ steps.check-release.outputs.command }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: 'main'
@@ -42,18 +39,18 @@ jobs:
     if: needs.check-plan.outputs.command == 'release'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/setup
         with:
           use_pinned_node: "true"
-      - name: Install Node
-        uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           # This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
           registry-url: 'https://registry.npmjs.org'
 
       - name: npm publish
-        run: node ./test-packages/release/src/cli.js publish
+        run: pnpm release-plan publish
+
         env:
           GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release-plan-preview.yml

@@ -3,35 +3,59 @@ on:
   push:
     branches:
       - main
+  pull_request:
+    types:
+      - labeled
+
+concurrency:
+  group: plan-release # only the latest one of these should ever be running
+  cancel-in-progress: true
 
 jobs:
+  check-plan:
+    name: "Check Release Plan"
+    runs-on: ubuntu-latest
+    outputs:
+      command: ${{ steps.check-release.outputs.command }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: 'main'
+      # This will only cause the `check-plan` job to have a "command" of `release`
+      # when the .release-plan.json file was changed on the last commit.
+      - id: check-release
+        run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
+
   prepare_release_notes:
     name: Prepare Release Notes
     runs-on: ubuntu-latest
     timeout-minutes: 5
+    needs: check-plan
     outputs:
       explanation: ${{ steps.explanation.outputs.text }}
+    # only run on push event if plan wasn't updated (don't create a release plan when we're releasing)
+    # only run on labeled event if the PR has already been merged
+    if: (github.event_name == 'push' && needs.check-plan.outputs.command != 'release') || (github.event_name == 'pull_request' && github.event.pull_request.merged == true)
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         # We need to download lots of history so that
         # lerna-changelog can discover what's changed since the last release
         with:
           fetch-depth: 0
       - uses: ./.github/actions/setup
         with:
           use_pinned_node: true
+
       - name: "Generate Explanation and Prep Changelogs"
         id: explanation
         run: |
-          # Print each command out to the terminal before running
           set -x
-          # For an unknown reason the `pnpm embroider-release` bin is not
-          # wired up as it is locally.
-          node ./test-packages/release/src/cli.js prepare
-          # Don't print this, because it can be very large
-          set +x
-          # Have to use this EOF syntax for multi-line strings.
+
+          pnpm release-plan prepare
+
           echo 'text<<EOF' >> $GITHUB_OUTPUT
           jq .description .release-plan.json -r >> $GITHUB_OUTPUT
           echo 'EOF' >> $GITHUB_OUTPUT
@@ -40,15 +64,13 @@ jobs:
 
       - uses: peter-evans/create-pull-request@v5
         with:
-          commit-message: "Prepare Release using 'embroider-release'"
+          commit-message: "Prepare Release using 'release-plan'"
           author: "github-actions[bot] <[email protected]>"
           labels: "internal"
-          branch: embroider-release-preview
+          branch: release-preview
           title: Prepare Release
           body: |
-            Preview of the Release.
-
-            See `.github/workflows/release-plan-preview.yml` for how this PR was created.
+            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 👍
 
             -----------------------------------------
 

RELEASE.md

@@ -1,26 +1,27 @@
 # Release Process
 
-1. You need a github token as `GITHUB_AUTH` environment variable.
+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 prepare the release once the PR is merged.
 
-2. Run `pnpm embroider-release explain-plan`. If there are unlabeled PRs that need to be released it will complain and show you a list of them. Each PR needs to be labeled with one of: 
-    - breaking
-    - enhancement
-    - bug
-    - documentation
-    - internal
+## Preparation
 
-3. Once all the PRs are labeled, it will instead show you the release plan, explaining which packages are getting released, at which versions, and why.
+Since the majority of the actual release process is automated, the remaining tasks before releasing are: 
 
-4. If you disagree with the plan, you can modify the list of changes before using it to `explain-plan` or `prepare` a release:
+-  correctly labeling **all** pull requests that have been merged since the last release
+-  updating pull request titles so they make sense to our users
 
-    - `pnpm embroider-release gather-changes > /tmp/changelog`
-    - edit `/tmp/changelog`
-    - `pnpm embroider-release explain-plan --from-stdin < /tmp/changelog`
+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.
 
-    For example, this can be necessary if a PR that's labeled `breaking` touches multiple packages and only one of those packages is actually a breaking change. In that case you can take the other package names out of the description of the PR.
+When reviewing merged PR's the labels to be used are:
 
-5. Once you're happy with the plan, run `pnpm embroider-release prepare`. This will edit CHANGELOG.md, bump the version numbers in package.json files, and create a file named `.release-plan.json`. Make a PR with these changes.
+* 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.
 
-6. Once the PR is merged, in a clean local repo at the merge commit, run `pnpm embroider-release publish`.
+**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
+
+Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/embroider-build/embroider/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

package.json

@@ -36,7 +36,6 @@
     }
   },
   "devDependencies": {
-    "@embroider/release": "workspace:*",
     "@types/jest": "^29.2.0",
     "@typescript-eslint/eslint-plugin": "^5.59.5",
     "@typescript-eslint/parser": "^5.59.5",
@@ -48,6 +47,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "jest": "^29.2.1",
     "prettier": "^2.3.1",
+    "release-plan": "^0.4.1",
     "typescript": "^5.1.6"
   },
   "publishConfig": {