Skip to content

Commit ebd2760

Browse files
NullVoxPopuliNullVoxPopuli
authored
Merge pull request #1460 from emberjs/setup-release-plan
Setup release plan
2 parents 4e0c492 + 3f8ea8d commit ebd2760

File tree

7 files changed

+455
-71
lines changed

7 files changed

+455
-71
lines changed

‎.github/workflows/plan-release.yml

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
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+
pull-requests: write
41+
outputs:
42+
explanation: ${{ steps.explanation.outputs.text }}
43+
# only run on push event 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' && needs.check-plan.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: 'master'
54+
- uses: actions/setup-node@v4
55+
with:
56+
node-version: 18
57+
- uses: pnpm/action-setup@v4
58+
- run: pnpm install --frozen-lockfile
59+
- name: "Generate Explanation and Prep Changelogs"
60+
id: explanation
61+
run: |
62+
set +e
63+
pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
64+
65+
if [ $? -ne 0 ]; then
66+
echo 'text<<EOF' >> $GITHUB_OUTPUT
67+
cat release-plan-stderr.txt >> $GITHUB_OUTPUT
68+
echo 'EOF' >> $GITHUB_OUTPUT
69+
else
70+
echo 'text<<EOF' >> $GITHUB_OUTPUT
71+
jq .description .release-plan.json -r >> $GITHUB_OUTPUT
72+
echo 'EOF' >> $GITHUB_OUTPUT
73+
rm release-plan-stderr.txt
74+
fi
75+
env:
76+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
77+
78+
- uses: peter-evans/create-pull-request@v6
79+
with:
80+
commit-message: "Prepare Release using 'release-plan'"
81+
labels: "internal"
82+
branch: release-preview
83+
title: Prepare Release
84+
body: |
85+
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 👍
86+
87+
-----------------------------------------
88+
89+
${{ steps.explanation.outputs.text }}

‎.github/workflows/publish.yml

+58
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 }}

‎addon/CHANGELOG.md ‎CHANGELOG.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
# CHANGELOG
2-
3-
4-
5-
6-
7-
1+
# Changelog
82

93

104
## v3.3.0 (2024-02-12)

‎RELEASE.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Release Process
2+
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.
4+
5+
## Preparation
6+
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
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/emberjs/ember-test-helpers/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎addon/RELEASE.md

-60
This file was deleted.

‎package.json

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22
"name": "root",
33
"version": "0.0.0",
44
"private": true,
5-
"license": "(MIT OR Apache-2.0)",
65
"repository": "https://github.com/emberjs/ember-test-helpers",
6+
"license": "(MIT OR Apache-2.0)",
77
"scripts": {
88
"lint": "pnpm --filter '*' lint",
99
"lint:fix": "pnpm --filter '*' lint:fix",
1010
"test": "pnpm --filter '*' test"
1111
},
12+
"devDependencies": {
13+
"release-plan": "^0.9.0"
14+
},
15+
"packageManager": "pnpm@9.5.0",
1216
"volta": {
1317
"node": "18.20.4",
1418
"pnpm": "9.5.0"
15-
},
16-
"packageManager": "pnpm@9.5.0"
19+
}
1720
}

0 commit comments

Comments
 (0)