Skip to content

Commit aef9a42

Browse files
mansonamansona
committed
start using release-plan
1 parent 673ed20 commit aef9a42

File tree

5 files changed

+478
-1408
lines changed

5 files changed

+478
-1408
lines changed

‎.github/workflows/plan-release.yml

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
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: 'main'
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+
# github-changelog can discover what's changed since the last release
50+
with:
51+
fetch-depth: 0
52+
ref: 'main'
53+
- uses: actions/setup-node@v4
54+
with:
55+
node-version: 18
56+
57+
- uses: pnpm/action-setup@v3
58+
with:
59+
version: 8
60+
- run: pnpm install --frozen-lockfile
61+
62+
- name: "Generate Explanation and Prep Changelogs"
63+
id: explanation
64+
run: |
65+
set +e
66+
67+
pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
68+
69+
70+
if [ $? -ne 0 ]; then
71+
echo 'text<<EOF' >> $GITHUB_OUTPUT
72+
cat release-plan-stderr.txt >> $GITHUB_OUTPUT
73+
echo 'EOF' >> $GITHUB_OUTPUT
74+
else
75+
echo 'text<<EOF' >> $GITHUB_OUTPUT
76+
jq .description .release-plan.json -r >> $GITHUB_OUTPUT
77+
echo 'EOF' >> $GITHUB_OUTPUT
78+
rm release-plan-stderr.txt
79+
fi
80+
env:
81+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
82+
83+
- uses: peter-evans/create-pull-request@v6
84+
with:
85+
commit-message: "Prepare Release using 'release-plan'"
86+
labels: "internal"
87+
branch: release-preview
88+
title: Prepare Release
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

+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: 'main'
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@v3
54+
with:
55+
version: 8
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 }}

‎RELEASE.md

+11-44
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
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
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
1613
guiding principle here is that changelogs are for humans, not machines.
1714

1815
When reviewing merged PR's the labels to be used are:
@@ -21,40 +18,10 @@ When reviewing merged PR's the labels to be used are:
2118
- enhancement - Used when the PR adds a new feature or enhancement.
2219
- bug - Used when the PR fixes a bug included in a previous release.
2320
- 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:
30-
31-
- First, ensure that you have installed your projects dependencies:
21+
- internal - Internal changes or things that don't fit in any other category.
3222

33-
```sh
34-
yarn install
35-
```
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`
3624

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-
```
47-
48-
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
49-
50-
- And last (but not least 😁) do your release.
51-
52-
```sh
53-
npx release-it
54-
```
25+
## Release
5526

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.
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/adopted-ember-addons/ember-popper-modifier/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎package.json

+6-23
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"scripts": {
3131
"build": "ember build --environment=production",
3232
"build:types": "glint --declaration",
33+
"postinstall": "husky install",
3334
"lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"",
3435
"lint:css": "stylelint \"**/*.css\"",
3536
"lint:css:fix": "concurrently \"npm:lint:css -- --fix\"",
@@ -45,15 +46,13 @@
4546
"lint:types": "glint",
4647
"lint:yml": "prettier --check '**/*.yml'",
4748
"lint:yml:fix": "prettier --write '**/*.yml'",
49+
"prepack": "pnpm run build:types",
50+
"prepublishOnly": "pinst --disable",
51+
"postpublish": "pinst --enable",
4852
"start": "ember serve",
4953
"test": "concurrently \"npm:lint\" \"npm:test:*\" --names \"lint,test:\"",
5054
"test:ember": "ember test",
51-
"test:ember-compatibility": "ember try:each",
52-
"release": "release-it",
53-
"postinstall": "husky install",
54-
"prepack": "pnpm run build:types",
55-
"prepublishOnly": "pinst --disable",
56-
"postpublish": "pinst --enable"
55+
"test:ember-compatibility": "ember try:each"
5756
},
5857
"lint-staged": {
5958
"*.hbs": "ember-template-lint",
@@ -79,7 +78,6 @@
7978
"@glint/core": "^1.3.0",
8079
"@glint/environment-ember-loose": "^1.3.0",
8180
"@glint/template": "^1.3.0",
82-
"@release-it-plugins/lerna-changelog": "^6.0.0",
8381
"@tsconfig/ember": "^3.0.3",
8482
"@types/qunit": "^2.19.10",
8583
"@types/rsvp": "^4.0.9",
@@ -115,7 +113,7 @@
115113
"qunit": "^2.20.0",
116114
"qunit-dom": "^3.0.0",
117115
"qunit-wait-for": "^2.0.0",
118-
"release-it": "^17.0.5",
116+
"release-plan": "^0.9.0",
119117
"rimraf": "^5.0.1",
120118
"stylelint": "^15.11.0",
121119
"stylelint-config-standard": "^34.0.0",
@@ -142,20 +140,5 @@
142140
},
143141
"ember-addon": {
144142
"configPath": "tests/dummy/config"
145-
},
146-
"release-it": {
147-
"plugins": {
148-
"@release-it-plugins/lerna-changelog": {
149-
"infile": "CHANGELOG.md",
150-
"launchEditor": true
151-
}
152-
},
153-
"git": {
154-
"tagName": "v${version}"
155-
},
156-
"github": {
157-
"release": true,
158-
"tokenRef": "GITHUB_AUTH"
159-
}
160143
}
161144
}

0 commit comments

Comments
 (0)