Skip to content

Commit 143c8a7

Browse files
NullVoxPopuliNullVoxPopuli
authored
Merge pull request #18 from NullVoxPopuli/update-release-plan
Update release-plan
2 parents d7a7a14 + 42c4978 commit 143c8a7

File tree

5 files changed

+423
-588
lines changed

5 files changed

+423
-588
lines changed

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

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,91 @@
1-
name: Release Plan Review
1+
name: Plan Release
22
on:
3+
workflow_dispatch:
34
push:
45
branches:
56
- main
67
- master
7-
pull_request:
8-
types:
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:
910
- labeled
11+
- unlabeled
1012

1113
concurrency:
1214
group: plan-release # only the latest one of these should ever be running
1315
cancel-in-progress: true
1416

1517
jobs:
16-
check-plan:
17-
name: "Check Release Plan"
18+
is-this-a-release:
19+
name: "Is this a release?"
1820
runs-on: ubuntu-latest
1921
outputs:
2022
command: ${{ steps.check-release.outputs.command }}
2123

2224
steps:
2325
- uses: actions/checkout@v4
2426
with:
25-
fetch-depth: 0
27+
fetch-depth: 2
2628
ref: 'main'
27-
# This will only cause the `check-plan` job to have a "command" of `release`
29+
# This will only cause the `is-this-a-release` job to have a "command" of `release`
2830
# when the .release-plan.json file was changed on the last commit.
2931
- id: check-release
3032
run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
3133

32-
prepare_release_notes:
33-
name: Prepare Release Notes
34+
create-prepare-release-pr:
35+
name: Create Prepare Release PR
3436
runs-on: ubuntu-latest
3537
timeout-minutes: 5
36-
needs: check-plan
38+
needs: is-this-a-release
3739
permissions:
3840
contents: write
41+
issues: read
3942
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 push event or workflow dispatch if plan wasn't updated (don't create a release plan when we're releasing)
4344
# 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+
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)
4546

4647
steps:
4748
- uses: actions/checkout@v4
4849
# We need to download lots of history so that
49-
# lerna-changelog can discover what's changed since the last release
50+
# github-changelog can discover what's changed since the last release
5051
with:
5152
fetch-depth: 0
53+
ref: 'main'
54+
- uses: pnpm/action-setup@v4
5255
- uses: actions/setup-node@v4
5356
with:
5457
node-version: 18
55-
56-
- uses: pnpm/action-setup@v2
57-
with:
58-
version: 8
58+
cache: pnpm
5959
- run: pnpm install --frozen-lockfile
60-
6160
- name: "Generate Explanation and Prep Changelogs"
6261
id: explanation
6362
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
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
7180
env:
7281
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
7382

74-
- uses: peter-evans/create-pull-request@v5
83+
- uses: peter-evans/create-pull-request@v7
7584
with:
76-
commit-message: "Prepare Release using 'release-plan'"
77-
author: "github-actions[bot] <github-actions-bot@users.noreply.github.com>"
85+
commit-message: "Prepare Release ${{ steps.explanation.outputs.new_version}} using 'release-plan'"
7886
labels: "internal"
7987
branch: release-preview
80-
title: Prepare Release
88+
title: Prepare Release ${{ steps.explanation.outputs.new_version }}
8189
body: |
8290
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 👍
8391

‎.github/workflows/publish.yml‎

Lines changed: 10 additions & 29 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,53 +9,35 @@ 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
4325
pull-requests: write
26+
id-token: write
27+
attestations: write
4428

4529
steps:
4630
- uses: actions/checkout@v4
31+
- uses: pnpm/action-setup@v4
4732
- uses: actions/setup-node@v4
4833
with:
4934
node-version: 18
5035
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
5136
registry-url: 'https://registry.npmjs.org'
52-
53-
- uses: pnpm/action-setup@v2
54-
with:
55-
version: 8
37+
cache: pnpm
5638
- run: pnpm install --frozen-lockfile
57-
- name: npm publish
58-
run: pnpm release-plan publish
59-
39+
- name: Publish to NPM
40+
run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish
6041
env:
6142
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
6243
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎RELEASE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release Process
22

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

55
## Preparation
66

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"eslint": "^8.56.0",
5959
"prettier": "^3.2.4",
6060
"publint": "^0.2.7",
61-
"release-plan": "^0.7.0",
61+
"release-plan": "^0.16.0",
6262
"typescript": "^5.3.3",
6363
"vitest": "^1.2.2"
6464
},

0 commit comments

Comments
 (0)