Skip to content

Commit 4b39f47

Browse files
mansonamansona
committed
start using release-plan
1 parent 83ad637 commit 4b39f47

File tree

8 files changed

+612
-1134
lines changed

8 files changed

+612
-1134
lines changed

‎.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010
- cron: '0 3 * * *' # daily, at 3am
1111

1212
env:
13-
PNPM_VERSION: 6.35.1
13+
PNPM_VERSION: 6
1414

1515
jobs:
1616
lint:

‎.github/workflows/plan-release.yml

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

‎.github/workflows/publish.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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+
53+
- uses: pnpm/action-setup@v2
54+
with:
55+
version: 6
56+
- run: pnpm install --frozen-lockfile
57+
- name: npm publish
58+
run: pnpm release-plan publish
59+
60+
env:
61+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
62+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.github/workflows/release.yml

-22
This file was deleted.

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
auto-install-peers=false

‎RELEASE.md

+11-40
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
1-
# Release
2-
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/).
1+
# Release Process
62

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 prepare the release once the PR is merged.
74

85
## Preparation
96

10-
Since the majority of the actual release process is automated, the primary
11-
remaining task prior to releasing is confirming that all pull requests that
12-
have been merged since the last release have been labeled with the appropriate
13-
`lerna-changelog` labels and the titles have been updated to ensure they
14-
represent something that would make sense to our users. Some great information
15-
on why this is important can be found at
16-
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
7+
Since the majority of the actual release process is automated, the remaining tasks before releasing are:
8+
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
11+
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
1713
guiding principle here is that changelogs are for humans, not machines.
1814

1915
When reviewing merged PR's the labels to be used are:
@@ -22,35 +18,10 @@ When reviewing merged PR's the labels to be used are:
2218
* enhancement - Used when the PR adds a new feature or enhancement.
2319
* bug - Used when the PR fixes a bug included in a previous release.
2420
* documentation - Used when the PR adds or updates documentation.
25-
* internal - Used for internal changes that still require a mention in the
26-
changelog/release notes.
21+
* internal - Internal changes or things that don't fit in any other category.
2722

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`
2824

2925
## Release
3026

31-
Once the prep work is completed, the actual release is straight forward:
32-
33-
* First, ensure that you have an environment variable with your GitHub token
34-
setup as `GITHUB_AUTH`. This token will be used for generating your changelog
35-
(unauthenticated requests to the GitHub API are heavily throttled) and for
36-
creating the GitHub release. Only "repo" access is needed; no "admin"
37-
or other scopes are required.
38-
39-
* Next, ensure that you have installed your projects dependencies:
40-
41-
```
42-
pnpm install
43-
```
44-
45-
* And last (but not least 😁) do your release:
46-
47-
```
48-
pnpm release
49-
```
50-
51-
[release-it](https://github.com/release-it/release-it/) manages the actual
52-
release process. It will prompt you to to choose the version number after which
53-
you will have the chance to hand tweak the changelog to be used (for the
54-
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
55-
pushing the tag and commits, etc. Finally GitHub Actions will build the commit
56-
and push the release 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/mainmatter/ember-test-selectors/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎package.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,17 @@
55
"keywords": [
66
"ember-addon"
77
],
8+
"repository": "https://github.com/mainmatter/ember-test-selectors",
89
"license": "MIT",
910
"author": "Mainmatter GmbH",
1011
"directories": {
1112
"doc": "doc",
1213
"test": "tests"
1314
},
14-
"repository": "https://github.com/mainmatter/ember-test-selectors",
1515
"scripts": {
1616
"build": "ember build",
1717
"changelog": "lerna-changelog",
1818
"lint": "eslint . --cache",
19-
"release": "release-it",
2019
"start": "ember server",
2120
"test": "npm run test:keep && npm run test:strip",
2221
"test:all": "ember try:each",
@@ -60,8 +59,7 @@
6059
"prettier": "2.8.5",
6160
"qunit": "2.19.4",
6261
"qunit-dom": "2.0.0",
63-
"release-it": "14.14.3",
64-
"release-it-lerna-changelog": "4.0.1",
62+
"release-plan": "^0.7.0",
6563
"webpack": "5.76.2"
6664
},
6765
"engines": {

0 commit comments

Comments
 (0)