-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1607 from glimmerjs/release-plan
Setup Release plan, remove release-it
- Loading branch information
Showing
7 changed files
with
622 additions
and
251 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
name: Release Plan Review | ||
on: | ||
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: | ||
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 | ||
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: 'main' | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: 18 | ||
- uses: pnpm/action-setup@v4 | ||
with: | ||
version: 9 | ||
- 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@v6 | ||
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://github.com/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍 | ||
----------------------------------------- | ||
${{ steps.explanation.outputs.text }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# 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 | ||
|
||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- main | ||
- 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: 'main' | ||
# 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: actions/setup-node@v4 | ||
with: | ||
node-version: 18 | ||
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable | ||
registry-url: 'https://registry.npmjs.org' | ||
- uses: pnpm/action-setup@v4 | ||
with: | ||
version: 9 | ||
- run: pnpm install --frozen-lockfile | ||
- name: npm publish | ||
run: pnpm release-plan publish | ||
env: | ||
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }} | ||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# Changelog | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,27 @@ | ||
# Release Process | ||
|
||
> **Warning** | ||
> this file is currently outdated, but will be updated soon. | ||
Releases are mostly automated using | ||
[release-it](https://github.com/release-it/release-it/) and | ||
[lerna-changelog](https://github.com/lerna/lerna-changelog/). | ||
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 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 - 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 installed your projects dependencies: | ||
|
||
```sh | ||
yarn install | ||
``` | ||
|
||
- Second, ensure that you have obtained a | ||
[GitHub personal access token][generate-token] with the `repo` scope (no | ||
other permissions are needed). Make sure the token is available as the | ||
`GITHUB_AUTH` environment variable. | ||
|
||
For instance: | ||
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. | ||
|
||
```bash | ||
export GITHUB_AUTH=abc123def456 | ||
``` | ||
When reviewing merged PR's the labels to be used are: | ||
|
||
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable | ||
* 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` | ||
|
||
```sh | ||
npx release-it | ||
``` | ||
## Release | ||
|
||
[release-it](https://github.com/release-it/release-it/) manages the actual | ||
release process. It will prompt you to to choose the version number after which | ||
you will have the chance to hand tweak the changelog to be used (for the | ||
`CHANGELOG.md` and GitHub release), then `release-it` continues on to 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/glimmerjs/glimmer-vm/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,27 +36,6 @@ | |
"test:types": "node bin/run-types-tests.mjs", | ||
"unlink:all": "esyes ./bin/unlink-all.mts" | ||
}, | ||
"pnpm": { | ||
"overrides": { | ||
"@rollup/pluginutils": "^5.0.2", | ||
"@types/node": "$@types/node", | ||
"typescript": "$typescript" | ||
}, | ||
"patchedDependencies": { | ||
"@release-it-plugins/[email protected]": "patches/@[email protected]" | ||
}, | ||
"peerDependencyRules": { | ||
"allowAny": [ | ||
"vite-plugin-babel", | ||
"vite" | ||
], | ||
"allowedVersions": { | ||
"@rollup/pluginutils": "5", | ||
"rollup": "3", | ||
"typescript": "5" | ||
} | ||
} | ||
}, | ||
"devDependencies": { | ||
"@babel/plugin-syntax-dynamic-import": "^7.8.3", | ||
"@babel/plugin-transform-modules-commonjs": "^7.23.3", | ||
|
@@ -115,6 +94,7 @@ | |
"puppeteer-chromium-resolver": "^20.0.0", | ||
"qunit": "^2.19.4", | ||
"release-it": "^16.2.1", | ||
"release-plan": "^0.9.0", | ||
"rimraf": "^5.0.0", | ||
"rollup": "^4.5.1", | ||
"semver": "^7.5.2", | ||
|
@@ -128,33 +108,6 @@ | |
"xo": "^0.54.2", | ||
"zx": "^7.2.3" | ||
}, | ||
"release-it": { | ||
"plugins": { | ||
"@release-it-plugins/workspaces": { | ||
"publish": false, | ||
"workspaces": [ | ||
"packages/@glimmer/*" | ||
], | ||
"additionalManifests": { | ||
"dependencyUpdates": [] | ||
} | ||
}, | ||
"@release-it-plugins/lerna-changelog": { | ||
"infile": "CHANGELOG.md", | ||
"launchEditor": true | ||
} | ||
}, | ||
"git": { | ||
"commitMessage": "v${version}", | ||
"tagName": "v${version}" | ||
}, | ||
"github": { | ||
"release": true, | ||
"releaseName": "v${version}", | ||
"tokenRef": "GITHUB_AUTH" | ||
}, | ||
"npm": false | ||
}, | ||
"changelog": { | ||
"repo": "glimmerjs/glimmer-vm", | ||
"labels": { | ||
|
@@ -171,5 +124,23 @@ | |
"volta": { | ||
"node": "20.9.0", | ||
"pnpm": "8.5.0" | ||
}, | ||
"pnpm": { | ||
"overrides": { | ||
"@rollup/pluginutils": "^5.0.2", | ||
"@types/node": "$@types/node", | ||
"typescript": "$typescript" | ||
}, | ||
"peerDependencyRules": { | ||
"allowAny": [ | ||
"vite-plugin-babel", | ||
"vite" | ||
], | ||
"allowedVersions": { | ||
"@rollup/pluginutils": "5", | ||
"rollup": "3", | ||
"typescript": "5" | ||
} | ||
} | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.