Skip to content

Commit baaeed5

Browse files
NullVoxPopuliNullVoxPopuli
authored
Merge pull request #4 from proposal-signals/release-plan
Setup release automation
2 parents 18a029d + 0babd8c commit baaeed5

File tree

6 files changed

+1712
-22
lines changed

6 files changed

+1712
-22
lines changed

‎.github/workflows/plan-release.yml

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

‎.github/workflows/publish.yml

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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: wyvox/action-setup-pnpm@v3
48+
with:
49+
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
50+
node-registry-url: 'https://registry.npmjs.org'
51+
- run: pnpm install --frozen-lockfile
52+
- name: npm publish
53+
run: pnpm release-plan publish
54+
55+
env:
56+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
57+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Changelog

‎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/proposal-signals/proposal-signals/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎package.json

+10-9
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,32 @@
22
"name": "signal-polyfill",
33
"version": "0.1.0",
44
"description": "A polyfill for the TC39 Signal proposal.",
5-
"contributors": [
6-
"Google LLC",
7-
"Bloomberg Finance L.P.",
8-
"EisenbergEffect"
9-
],
10-
"main": "dist/index.js",
115
"repository": {
126
"type": "git",
137
"url": "https://github.com/proposal-signals/proposal-signals.git",
148
"directory": "packages/signal-polyfill"
159
},
10+
"license": "Apache-2.0",
11+
"author": "EisenbergEffect",
12+
"contributors": [
13+
"Google LLC",
14+
"Bloomberg Finance L.P.",
15+
"EisenbergEffect"
16+
],
1617
"type": "module",
18+
"main": "dist/index.js",
1719
"types": "dist/index.d.ts",
1820
"scripts": {
19-
"dev": "vite",
2021
"build": "tsc && vite build",
22+
"dev": "vite",
2123
"prepack": "npm run build",
2224
"test": "vitest"
2325
},
24-
"author": "EisenbergEffect",
25-
"license": "Apache-2.0",
2626
"devDependencies": {
2727
"@types/node": "^20.11.25",
2828
"@vitest/browser": "^1.5.3",
2929
"prettier": "^3.2.5",
30+
"release-plan": "^0.9.0",
3031
"typescript": "latest",
3132
"vite": "^5.2.6",
3233
"vite-plugin-dts": "^3.7.3",

0 commit comments

Comments
 (0)