chore(release): use release-plan

.github/workflows/plan-release.yml

@@ -0,0 +1,89 @@
+name: Release Plan Review
+on:
+ push:
+ branches:
+ - 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
+
+env:
+ VOLTA_FEATURE_PNPM: 1
+
+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: 'master'
+ # 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
+ permissions:
+ contents: write
+ issues: read
+ pull-requests: write
+ 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_target' && github.event.pull_request.merged == true)
+
+ steps:
+ - uses: actions/checkout@v4
+ # We need to download lots of history so that
+ # github-changelog can discover what's changed since the last release
+ with:
+ fetch-depth: 0
+ ref: 'master'
+ - uses: ./.github/actions/pnpm-setup
+ - run: pnpm install --frozen-lockfile
+ - name: "Generate Explanation and Prep Changelogs"
+ id: explanation
+ run: |
+ set +e
+ pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
+
+ if [ $? -ne 0 ]; then
+ echo 'text<<EOF' >> $GITHUB_OUTPUT
+ cat release-plan-stderr.txt >> $GITHUB_OUTPUT
+ echo 'EOF' >> $GITHUB_OUTPUT
+ else
+ echo 'text<<EOF' >> $GITHUB_OUTPUT
+ jq .description .release-plan.json -r >> $GITHUB_OUTPUT
+ echo 'EOF' >> $GITHUB_OUTPUT
+ rm release-plan-stderr.txt
+ fi
+ env:
+ GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+
+ - uses: peter-evans/create-pull-request@v7
+ with:
+ commit-message: "Prepare Release using 'release-plan'"
+ labels: "internal"
+ branch: release-preview
+ title: Prepare Release
+ body: |
+ This PR is a preview of the release that [release-plan](https:/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍
+
+ -----------------------------------------
+
+ ${{ steps.explanation.outputs.text }}

.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+# 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
+
+name: Publish Stable
+
+env:
+ VOLTA_FEATURE_PNPM: 1
+
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - master
+
+concurrency:
+ group: publish-${{ github.head_ref || github.ref }}
+ 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: 'master'
+ # This will only cause the `check-plan` job to have a result of `success`
+ # when the .release-plan.json file was changed on the last commit. This
+ # plus the fact that this action only runs on main will be enough of a guard
+ - 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
+
+ publish:
+ name: "NPM Publish"
+ runs-on: ubuntu-latest
+ needs: check-plan
+ if: needs.check-plan.outputs.command == 'release'
+ permissions:
+ contents: write
+ pull-requests: write
+
+ steps:
+ - uses: actions/checkout@v4
+ - uses: ./.github/actions/pnpm-setup
+ - run: pnpm install --frozen-lockfile
+ - name: Set publishing config
+ run: pnpm config set '//registry.npmjs.org/:_authToken' "${NODE_AUTH_TOKEN}"
+ env:
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+ - name: npm publish
+ run: pnpm release-plan publish
+ env:
+ GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -1,3 +1,5 @@
+# Changelog
+
 # 1.1.2
 
 * **Fix** chore(ci): use pull_request_target event to allow continue-on-error-comment to work for forks by @BobrImperator in https:/mainmatter/ember-cookies/pull/901

RELEASE.md

@@ -0,0 +1,27 @@
+# Release Process
+
+Releases in this repo are mostly automated using [release-plan](https:/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 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:/simplabs/ember-cookies/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

package.json

@@ -9,23 +9,25 @@
  "scripts": {
  "lint": "concurrently \"pnpm lint:addon\" \"pnpm lint:test-app\"",
  "lint:addon": "pnpm --filter ember-cookies lint",
- "lint:test-app": "pnpm --filter test-app lint",
  "lint:fix": "concurrently \"pnpm lint:fix:addon\" \"pnpm lint:fix:test-app\"",
  "lint:fix:addon": "pnpm --filter ember-cookies lint:fix",
  "lint:fix:test-app": "pnpm --filter test-app lint:fix",
+ "lint:test-app": "pnpm --filter test-app lint",
  "prepare": "pnpm --filter ember-cookies build",
  "start": "concurrently \"pnpm start:addon\" \"pnpm start:test-app\"",
  "start:addon": "pnpm --filter ember-cookies start",
  "start:test-app": "pnpm --filter test-app start",
  "test": "pnpm run test:test-app ember-default",
- "test:watch": "concurrently \"pnpm test:watch:test-app\" \"pnpm test:watch:addon\"",
  "test:test-app": "pnpm --filter test-app test:one",
- "test:watch:test-app": "pnpm --filter test-app test:watch",
- "test:watch:addon": "pnpm --filter ember-cookies start"
+ "test:watch": "concurrently \"pnpm test:watch:test-app\" \"pnpm test:watch:addon\"",
+ "test:watch:addon": "pnpm --filter ember-cookies start",
+ "test:watch:test-app": "pnpm --filter test-app test:watch"
  },
  "devDependencies": {
- "concurrently": "8.2.2"
+ "concurrently": "8.2.2",
+ "release-plan": "^0.9.0"
  },
+ "packageManager": "[email protected]",
  "volta": {
  "node": "20.17.0",
  "pnpm": "9.11.0"