Merge pull request #604 from embroider-build/update-release-plan

update release-plan

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

@@ -3,14 +3,42 @@ on:
   push:
     branches:
       - main
+      - master
+  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@v4
@@ -21,12 +49,16 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 16
+
       - run: npm ci
-      - name: "Generate Explanation and Prep Changelogs"
+
+      - name: 'Generate Explanation and Prep Changelogs'
         id: explanation
         run: |
           set -x
+
           npx release-plan prepare
+
           echo 'text<<EOF' >> $GITHUB_OUTPUT
           jq .description .release-plan.json -r >> $GITHUB_OUTPUT
           echo 'EOF' >> $GITHUB_OUTPUT
@@ -36,8 +68,8 @@ jobs:
       - uses: peter-evans/create-pull-request@v5
         with:
           commit-message: "Prepare Release using 'release-plan'"
-          author: "github-actions[bot] <[email protected]>"
-          labels: "internal"
+          author: 'github-actions[bot] <[email protected]>'
+          labels: 'internal'
           branch: release-preview
           title: Prepare Release
           body: |

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-# For every push to the main branch, this checks if the release-plan was
+# For every push to the master branch, this checks if the release-plan was
 # updated and if it was it will publish stable npm packages based on the
 # release plan
 
@@ -9,20 +9,21 @@ on:
   push:
     branches:
       - main
+      - master
 
 concurrency:
   group: publish-${{ github.head_ref || github.ref }}
   cancel-in-progress: true
 
 jobs:
   check-plan:
-    name: "Check Release Plan"
+    name: 'Check Release Plan'
     runs-on: ubuntu-latest
     outputs:
       command: ${{ steps.check-release.outputs.command }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: 'main'
@@ -33,7 +34,7 @@ jobs:
         run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
 
   publish:
-    name: "NPM Publish"
+    name: 'NPM Publish'
     runs-on: ubuntu-latest
     needs: check-plan
     if: needs.check-plan.outputs.command == 'release'
@@ -42,12 +43,14 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 18
           # This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
           registry-url: 'https://registry.npmjs.org'
+
       - run: npm ci
-      - name: Publish to npm
+      - name: npm publish
         run: npx release-plan publish
+
         env:
           GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

RELEASE.md

@@ -0,0 +1,27 @@
+# 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 prepare the release once the PR is merged.
+
+## Preparation
+
+Since the majority of the actual release process is automated, the remaining tasks before releasing are: 
+
+-  correctly labeling **all** pull requests that have been merged since the last release
+-  updating pull request titles so they make sense to our users
+
+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.
+
+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 - Internal changes or things that don't fit in any other category.
+
+**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/ember-auto-import/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR