Skip to content

Commit 95986cf

Browse files
NullVoxPopuliNullVoxPopuli
authored
Merge pull request #1190 from emberjs/setup-release-plan
Add release-plan, remove release-it
2 parents 3210508 + 11d0005 commit 95986cf

File tree

7 files changed

+624
-1693
lines changed

7 files changed

+624
-1693
lines changed

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

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

‎.github/workflows/publish.yml‎

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,43 @@
1-
name: Publish
1+
# For every push to the primary branch with .release-plan.json modified,
2+
# runs release-plan.
3+
4+
name: Publish Stable
25

36
on:
7+
workflow_dispatch:
48
push:
5-
tags:
6-
- '*'
9+
branches:
10+
- main
11+
- master
12+
paths:
13+
- '.release-plan.json'
14+
15+
concurrency:
16+
group: publish-${{ github.head_ref || github.ref }}
17+
cancel-in-progress: true
718

819
jobs:
920
publish:
10-
name: Publish to npm
11-
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
21+
name: "NPM Publish"
1222
runs-on: ubuntu-latest
13-
steps:
14-
- name: Checkout
15-
uses: actions/checkout@v3
23+
permissions:
24+
contents: write
25+
pull-requests: write
26+
id-token: write
27+
attestations: write
1628

17-
- name: Install node + Install deps with pnpm
18-
uses: wyvox/action-setup-pnpm@v3
29+
steps:
30+
- uses: actions/checkout@v4
31+
- uses: pnpm/action-setup@v4
32+
- uses: actions/setup-node@v4
1933
with:
20-
node-registry-url: 'https://registry.npmjs.org'
21-
22-
- name: auto-dist-tag
23-
run: npx auto-dist-tag --write
24-
working-directory: './addon/'
25-
26-
- name: publish to npm
27-
run: npm publish
34+
node-version: 18
35+
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
36+
registry-url: 'https://registry.npmjs.org'
37+
cache: pnpm
38+
- run: pnpm install --frozen-lockfile
39+
- name: Publish to NPM
40+
run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish
2841
env:
42+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
2943
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
30-
working-directory: './addon/'

‎addon/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

‎addon/RELEASE.md‎

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

3-
Releases are mostly automated using
4-
[release-it](https://github.com/release-it/release-it/) and
5-
[lerna-changelog](https://github.com/lerna/lerna-changelog/).
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.
64

75
## Preparation
86

9-
Since the majority of the actual release process is automated, the primary
10-
remaining task prior to releasing is confirming that all pull requests that
11-
have been merged since the last release have been labeled with the appropriate
12-
`lerna-changelog` labels and the titles have been updated to ensure they
13-
represent something that would make sense to our users. Some great information
14-
on why this is important can be found at
15-
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
16-
guiding principle here is that changelogs are for humans, not machines.
17-
18-
When reviewing merged PR's the labels to be used are:
19-
20-
* breaking - Used when the PR is considered a breaking change.
21-
* enhancement - Used when the PR adds a new feature or enhancement.
22-
* bug - Used when the PR fixes a bug included in a previous release.
23-
* documentation - Used when the PR adds or updates documentation.
24-
* internal - Used for internal changes that still require a mention in the
25-
changelog/release notes.
26-
27-
## Release
28-
29-
Once the prep work is completed, the actual release is straight forward:
7+
Since the majority of the actual release process is automated, the remaining tasks before releasing are:
308

31-
* First, ensure that you have installed your projects dependencies:
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
3211

33-
```sh
34-
pnpm install
35-
```
36-
37-
* Second, ensure that you have obtained a
38-
[GitHub personal access token][generate-token] with the `repo` scope (no
39-
other permissions are needed). Make sure the token is available as the
40-
`GITHUB_AUTH` environment variable.
41-
42-
For instance:
43-
44-
```bash
45-
export GITHUB_AUTH=abc123def456
46-
```
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.
4714

48-
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
15+
When reviewing merged PR's the labels to be used are:
4916

50-
* And last (but not least 😁) do your release.
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.
5122

52-
```sh
53-
cd addon && npx release-it
54-
```
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`
5524

56-
[release-it](https://github.com/release-it/release-it/) manages the actual
57-
release process. It will prompt you to to choose the version number after which
58-
you will have the chance to hand tweak the changelog to be used (for the
59-
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
60-
pushing the tag and commits, etc.
25+
## Release
6126

62-
CI will run on the pushed tag and deploy to npm.
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/emberjs/ember-qunit/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎addon/package.json‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@
6060
"@ember/test-helpers": "^3.0.3",
6161
"@embroider/addon-dev": "^3.0.0",
6262
"@glimmer/component": "^2.0.0",
63-
"@release-it-plugins/lerna-changelog": "^6.0.0",
6463
"@rollup/plugin-babel": "^5.3.0",
6564
"@tsconfig/ember": "^2.0.0",
6665
"@types/qunit": "^2.19.12",
@@ -75,7 +74,6 @@
7574
"expect-type": "^0.16.0",
7675
"prettier": "^2.8.8",
7776
"qunit": "^2.24.1",
78-
"release-it": "^16.1.5",
7977
"rollup": "^4.2.0",
8078
"typescript": "^4.9.5"
8179
},
@@ -106,24 +104,6 @@
106104
"main": "addon-main.cjs",
107105
"app-js": {}
108106
},
109-
"release-it": {
110-
"plugins": {
111-
"@release-it-plugins/lerna-changelog": {
112-
"infile": "CHANGELOG.md",
113-
"launchEditor": true
114-
}
115-
},
116-
"git": {
117-
"tagName": "v${version}"
118-
},
119-
"npm": {
120-
"publish": false
121-
},
122-
"github": {
123-
"release": true,
124-
"tokenRef": "GITHUB_AUTH"
125-
}
126-
},
127107
"volta": {
128108
"extends": "../package.json"
129109
}

‎package.json‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@
22
"name": "root",
33
"version": "0.0.0",
44
"private": true,
5-
"license": "MIT",
65
"repository": "https://github.com/emberjs/ember-qunit",
6+
"license": "MIT",
77
"scripts": {
8-
"prepare": "pnpm --filter ember-qunit build",
98
"lint": "pnpm --filter '*' run lint",
109
"lint:fix": "pnpm --filter '*' run lint:fix",
10+
"prepare": "pnpm --filter ember-qunit build",
1111
"test": "pnpm --filter '*' run test"
1212
},
13+
"devDependencies": {
14+
"release-plan": "^0.16.0"
15+
},
1316
"packageManager": "[email protected]",
1417
"volta": {
15-
"node": "18.16.0",
18+
"node": "^18.17.0",
1619
"pnpm": "10.7.0"
1720
},
1821
"pnpm": {

0 commit comments

Comments
 (0)