Skip to content

Commit 39caef2

Browse files
Update release-plan
1 parent 6d1dea9 commit 39caef2

File tree

6 files changed

+1509
-176
lines changed

6 files changed

+1509
-176
lines changed

.github/workflows/plan-release.yml

Lines changed: 20 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
name: Release Plan Review
1+
name: Plan Release
22
on:
3+
workflow_dispatch:
34
push:
45
branches:
56
- main
@@ -14,76 +15,44 @@ concurrency:
1415
cancel-in-progress: true
1516

1617
jobs:
17-
check-plan:
18-
name: "Check Release Plan"
18+
should-run-release-plan-prepare:
19+
name: Should we run release-plan prepare?
1920
runs-on: ubuntu-latest
2021
outputs:
21-
command: ${{ steps.check-release.outputs.command }}
22-
22+
should-prepare: ${{ steps.should-prepare.outputs.should-prepare }}
2323
steps:
24-
- uses: actions/checkout@v4
24+
- uses: release-plan/actions/should-prepare-release@v1
2525
with:
26-
fetch-depth: 0
2726
ref: 'main'
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
27+
id: should-prepare
3228

33-
prepare_release_notes:
34-
name: Prepare Release Notes
29+
create-prepare-release-pr:
30+
name: Create Prepare Release PR
3531
runs-on: ubuntu-latest
3632
timeout-minutes: 5
37-
needs: check-plan
33+
needs: should-run-release-plan-prepare
3834
permissions:
3935
contents: write
36+
issues: read
4037
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-
38+
if: needs.should-run-release-plan-prepare.outputs.should-prepare == 'true'
4739
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
40+
- uses: release-plan/actions/prepare@v1
41+
name: Run release-plan prepare
5142
with:
52-
fetch-depth: 0
5343
ref: 'main'
54-
- uses: actions/setup-node@v4
55-
with:
56-
node-version: 18
57-
58-
- run: npm ci
59-
60-
- name: "Generate Explanation and Prep Changelogs"
61-
id: explanation
62-
run: |
63-
set +e
64-
65-
npx release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
66-
67-
68-
if [ $? -ne 0 ]; then
69-
echo 'text<<EOF' >> $GITHUB_OUTPUT
70-
cat release-plan-stderr.txt >> $GITHUB_OUTPUT
71-
echo 'EOF' >> $GITHUB_OUTPUT
72-
else
73-
echo 'text<<EOF' >> $GITHUB_OUTPUT
74-
jq .description .release-plan.json -r >> $GITHUB_OUTPUT
75-
echo 'EOF' >> $GITHUB_OUTPUT
76-
rm release-plan-stderr.txt
77-
fi
7844
env:
7945
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
46+
id: explanation
8047

81-
- uses: peter-evans/create-pull-request@v6
48+
- uses: peter-evans/create-pull-request@v7
49+
name: Create Prepare Release PR
8250
with:
83-
commit-message: "Prepare Release using 'release-plan'"
51+
commit-message: "Prepare Release ${{ steps.explanation.outputs.new-version}} using 'release-plan'"
8452
labels: "internal"
53+
sign-commits: true
8554
branch: release-preview
86-
title: Prepare Release
55+
title: Prepare Release ${{ steps.explanation.outputs.new-version }}
8756
body: |
8857
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 👍
8958

.github/workflows/publish.yml

Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
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
1+
# For every push to the primary branch with .release-plan.json modified,
2+
# runs release-plan.
43

54
name: Publish Stable
65

@@ -10,50 +9,30 @@ on:
109
branches:
1110
- main
1211
- master
12+
paths:
13+
- '.release-plan.json'
1314

1415
concurrency:
1516
group: publish-${{ github.head_ref || github.ref }}
1617
cancel-in-progress: true
1718

1819
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-
3620
publish:
3721
name: "NPM Publish"
3822
runs-on: ubuntu-latest
39-
needs: check-plan
40-
if: needs.check-plan.outputs.command == 'release'
4123
permissions:
4224
contents: write
43-
pull-requests: write
25+
id-token: write
26+
attestations: write
4427

4528
steps:
46-
- uses: actions/checkout@v4
47-
- uses: actions/setup-node@v4
29+
- uses: actions/checkout@v5
30+
- uses: actions/setup-node@v6
4831
with:
49-
node-version: 18
50-
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
32+
node-version: 22
5133
registry-url: 'https://registry.npmjs.org'
52-
5334
- run: npm ci
54-
- name: npm publish
55-
run: npx release-plan publish
56-
35+
- name: Publish to NPM
36+
run: npx release-plan publish --provenance
5737
env:
5838
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
59-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.tool-versions

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
nodejs 22.17.0
1+
nodejs 22.21.1

RELEASE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ Releases in this repo are mostly automated using [release-plan](https://github.c
44

55
## Preparation
66

7-
Since the majority of the actual release process is automated, the remaining tasks before releasing are:
7+
Since the majority of the actual release process is automated, the remaining tasks before releasing are:
88

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
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
1111

1212
Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
1313
guiding principle here is that changelogs are for humans, not machines.
1414

1515
When reviewing merged PR's the labels to be used are:
1616

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.
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.
2222

2323
**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`
2424

0 commit comments

Comments
 (0)