Skip to content

Commit 0c2b7c9

Browse files
NullVoxPopuliNullVoxPopuli
authored
Merge pull request #2198 from ember-cli/release-plan
Switch away from release-it to release-plan
2 parents 6b218a5 + d9ef940 commit 0c2b7c9

6 files changed

Lines changed: 555 additions & 1511 deletions

File tree

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

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Release Plan Review
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- master
7+
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/
8+
types:
9+
- labeled
10+
- unlabeled
11+
12+
concurrency:
13+
group: plan-release # only the latest one of these should ever be running
14+
cancel-in-progress: true
15+
16+
jobs:
17+
check-plan:
18+
name: "Check Release Plan"
19+
runs-on: ubuntu-latest
20+
outputs:
21+
command: ${{ steps.check-release.outputs.command }}
22+
23+
steps:
24+
- uses: actions/checkout@v4
25+
with:
26+
fetch-depth: 0
27+
ref: 'master'
28+
# This will only cause the `check-plan` job to have a "command" of `release`
29+
# when the .release-plan.json file was changed on the last commit.
30+
- id: check-release
31+
run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
32+
33+
prepare_release_notes:
34+
name: Prepare Release Notes
35+
runs-on: ubuntu-latest
36+
timeout-minutes: 5
37+
needs: check-plan
38+
permissions:
39+
contents: write
40+
issues: read
41+
pull-requests: write
42+
outputs:
43+
explanation: ${{ steps.explanation.outputs.text }}
44+
# only run on push event if plan wasn't updated (don't create a release plan when we're releasing)
45+
# only run on labeled event if the PR has already been merged
46+
if: (github.event_name == 'push' && needs.check-plan.outputs.command != 'release') || (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true)
47+
48+
steps:
49+
- uses: actions/checkout@v4
50+
# We need to download lots of history so that
51+
# github-changelog can discover what's changed since the last release
52+
with:
53+
fetch-depth: 0
54+
ref: 'master'
55+
- uses: actions/setup-node@v4
56+
with:
57+
node-version: 18
58+
- uses: pnpm/action-setup@v4
59+
- run: pnpm install --frozen-lockfile
60+
- name: "Generate Explanation and Prep Changelogs"
61+
id: explanation
62+
run: |
63+
set +e
64+
pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
65+
66+
if [ $? -ne 0 ]; then
67+
echo 'text<<EOF' >> $GITHUB_OUTPUT
68+
cat release-plan-stderr.txt >> $GITHUB_OUTPUT
69+
echo 'EOF' >> $GITHUB_OUTPUT
70+
else
71+
echo 'text<<EOF' >> $GITHUB_OUTPUT
72+
jq .description .release-plan.json -r >> $GITHUB_OUTPUT
73+
echo 'EOF' >> $GITHUB_OUTPUT
74+
rm release-plan-stderr.txt
75+
fi
76+
env:
77+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
78+
79+
- uses: peter-evans/create-pull-request@v6
80+
with:
81+
commit-message: "Prepare Release using 'release-plan'"
82+
labels: "internal"
83+
branch: release-preview
84+
title: Prepare Release
85+
body: |
86+
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 👍
87+
88+
-----------------------------------------
89+
90+
${{ steps.explanation.outputs.text }}

‎.github/workflows/publish.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# For every push to the master branch, this checks if the release-plan was
2+
# updated and if it was it will publish stable npm packages based on the
3+
# release plan
4+
5+
name: Publish Stable
6+
7+
on:
8+
workflow_dispatch:
9+
push:
10+
branches:
11+
- main
12+
- master
13+
14+
concurrency:
15+
group: publish-${{ github.head_ref || github.ref }}
16+
cancel-in-progress: true
17+
18+
jobs:
19+
check-plan:
20+
name: "Check Release Plan"
21+
runs-on: ubuntu-latest
22+
outputs:
23+
command: ${{ steps.check-release.outputs.command }}
24+
25+
steps:
26+
- uses: actions/checkout@v4
27+
with:
28+
fetch-depth: 0
29+
ref: 'master'
30+
# This will only cause the `check-plan` job to have a result of `success`
31+
# when the .release-plan.json file was changed on the last commit. This
32+
# plus the fact that this action only runs on main will be enough of a guard
33+
- id: check-release
34+
run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
35+
36+
publish:
37+
name: "NPM Publish"
38+
runs-on: ubuntu-latest
39+
needs: check-plan
40+
if: needs.check-plan.outputs.command == 'release'
41+
permissions:
42+
contents: write
43+
pull-requests: write
44+
45+
steps:
46+
- uses: actions/checkout@v4
47+
- uses: actions/setup-node@v4
48+
with:
49+
node-version: 18
50+
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
51+
registry-url: 'https://registry.npmjs.org'
52+
- uses: pnpm/action-setup@v4
53+
- run: pnpm install --frozen-lockfile
54+
- name: npm publish
55+
run: pnpm release-plan publish
56+
env:
57+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
58+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Changelog
2+
13

24

35

‎RELEASE.md‎

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
1-
# Release Instructions
1+
# Release Process
22

3-
1. Check that notable PRs since the last release are labeled and have clear and consistent titles
3+
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.
44

5-
2. `git pull` the latest master and ensure that `git status` shows no local changes
5+
## Preparation
66

7-
3. `export GITHUB_AUTH="..."` with a [GitHub access token](https://github.com/settings/tokens/new?scopes=repo&description=release-it) with "repo" access so [release-it](https://github.com/release-it/release-it) can conduct a GitHub release and [lerna-changelog](https://github.com/lerna/lerna-changelog) can download the change history
7+
Since the majority of the actual release process is automated, the remaining tasks before releasing are:
88

9-
4. `export EDITOR="vim"` to choose an editor for editing the changelog
9+
- correctly labeling **all** pull requests that have been merged since the last release
10+
- updating pull request titles so they make sense to our users
1011

11-
5. `pnpm release` (uses [@release-it-plugins/lerna-changelog](https://github.com/release-it-plugins/lerna-changelog) to handle versioning, the changelog, publishing to GitHub and NPM, etc)
12+
Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
13+
guiding principle here is that changelogs are for humans, not machines.
14+
15+
When reviewing merged PR's the labels to be used are:
16+
17+
- breaking - Used when the PR is considered a breaking change.
18+
- enhancement - Used when the PR adds a new feature or enhancement.
19+
- bug - Used when the PR fixes a bug included in a previous release.
20+
- documentation - Used when the PR adds or updates documentation.
21+
- internal - Internal changes or things that don't fit in any other category.
22+
23+
**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`
24+
25+
## Release
26+
27+
Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/ember-cli/eslint-plugin-ember/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎package.json‎

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
"lib"
3838
],
3939
"scripts": {
40-
"changelog": "lerna-changelog",
4140
"lint": "npm-run-all --continue-on-error --aggregate-output --parallel \"lint:!(fix)\"",
4241
"lint:docs": "markdownlint \"**/*.md\"",
4342
"lint:docs:fix": "pnpm lint:docs --fix",
@@ -50,7 +49,6 @@
5049
"lint:package-json-sorting": "sort-package-json --check",
5150
"lint:package-json-sorting:fix": "sort-package-json package.json",
5251
"lint:remote": "eslint-remote-tester",
53-
"release": "release-it",
5452
"start": "pnpm test:watch",
5553
"test": "vitest run",
5654
"test:coverage": "vitest --coverage",
@@ -77,7 +75,6 @@
7775
"@babel/plugin-proposal-decorators": "^7.23.2",
7876
"@eslint/eslintrc": "^3.0.1",
7977
"@eslint/js": "^8.55.0",
80-
"@release-it-plugins/lerna-changelog": "^6.0.0",
8178
"@types/eslint": "^8.44.6",
8279
"@typescript-eslint/parser": "^7.0.1",
8380
"@vitest/coverage-v8": "^2.1.3",
@@ -100,7 +97,7 @@
10097
"npm-package-json-lint": "^7.0.0",
10198
"npm-run-all": "^4.1.5",
10299
"prettier": "^3.0.3",
103-
"release-it": "^17.0.0",
100+
"release-plan": "^0.9.0",
104101
"sort-package-json": "^2.6.0",
105102
"typescript": "^5.2.2",
106103
"typescript-eslint": "^8.7.0",
@@ -126,30 +123,5 @@
126123
},
127124
"publishConfig": {
128125
"registry": "https://registry.npmjs.org"
129-
},
130-
"changelog": {
131-
"repo": "ember-cli/eslint-plugin-ember",
132-
"labels": {
133-
"breaking": ":boom: Breaking Change",
134-
"enhancement": ":rocket: Enhancement",
135-
"bug": ":bug: Bug Fix",
136-
"documentation": ":memo: Documentation",
137-
"internal": ":house: Internal"
138-
}
139-
},
140-
"release-it": {
141-
"plugins": {
142-
"@release-it-plugins/lerna-changelog": {
143-
"infile": "CHANGELOG.md",
144-
"launchEditor": true
145-
}
146-
},
147-
"git": {
148-
"tagName": "v${version}"
149-
},
150-
"github": {
151-
"release": true,
152-
"tokenRef": "GITHUB_AUTH"
153-
}
154126
}
155127
}

0 commit comments

Comments
 (0)