Skip to content

Commit a5ea37a

Browse files
mansonamansona
authored
Merge pull request #2 from ember-cli/release-plan
start using release-plan
2 parents 1bb4e2e + bb816ea commit a5ea37a

File tree

6 files changed

+1119
-1941
lines changed

6 files changed

+1119
-1941
lines changed

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

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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: '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
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+
issues: read
41+
pull-requests: write
42+
outputs:
43+
explanation: ${{ steps.explanation.outputs.text }}
44+
# only run on push event if plan wasn't updated (don't create a release plan when we're releasing)
45+
# only run on labeled event if the PR has already been merged
46+
if: (github.event_name == 'push' && needs.check-plan.outputs.command != 'release') || (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true)
47+
48+
steps:
49+
- uses: actions/checkout@v4
50+
# We need to download lots of history so that
51+
# github-changelog can discover what's changed since the last release
52+
with:
53+
fetch-depth: 0
54+
ref: 'main'
55+
- uses: actions/setup-node@v4
56+
with:
57+
node-version: 18
58+
- uses: pnpm/action-setup@v4
59+
- run: pnpm install --frozen-lockfile
60+
- name: "Generate Explanation and Prep Changelogs"
61+
id: explanation
62+
run: |
63+
set +e
64+
pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
65+
66+
if [ $? -ne 0 ]; then
67+
echo 'text<<EOF' >> $GITHUB_OUTPUT
68+
cat release-plan-stderr.txt >> $GITHUB_OUTPUT
69+
echo 'EOF' >> $GITHUB_OUTPUT
70+
else
71+
echo 'text<<EOF' >> $GITHUB_OUTPUT
72+
jq .description .release-plan.json -r >> $GITHUB_OUTPUT
73+
echo 'EOF' >> $GITHUB_OUTPUT
74+
rm release-plan-stderr.txt
75+
fi
76+
env:
77+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
78+
79+
- uses: peter-evans/create-pull-request@v6
80+
with:
81+
commit-message: "Prepare Release using 'release-plan'"
82+
labels: "internal"
83+
branch: release-preview
84+
title: Prepare Release
85+
body: |
86+
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 👍
87+
88+
-----------------------------------------
89+
90+
${{ steps.explanation.outputs.text }}

‎.github/workflows/publish.yml‎

Lines changed: 58 additions & 0 deletions
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: '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+
- 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 }}

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Changelog

‎RELEASE.md‎

Lines changed: 27 additions & 0 deletions
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/ember-cli/babel-remove-types/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎package.json‎

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
11
{
22
"name": "babel-remove-types",
3-
"contributors": [
4-
"Chris Freeman",
5-
"Chris Manson <[email protected]>"
6-
],
73
"version": "0.0.0",
8-
"license": "MIT",
9-
"repository": {
10-
"type": "git",
11-
"url": "https://github.com/ember-cli/babel-remove-types"
12-
},
134
"keywords": [
145
"typescript",
156
"babel",
167
"types"
178
],
18-
"publishConfig": {
19-
"registry": "https://registry.npmjs.org/"
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/ember-cli/babel-remove-types"
2012
},
13+
"license": "MIT",
14+
"contributors": [
15+
"Chris Freeman",
16+
"Chris Manson <[email protected]>"
17+
],
2118
"main": "dist/cjs/index.js",
2219
"module": "dist/esm/index.js",
2320
"types": "index.d.ts",
@@ -28,19 +25,24 @@
2825
"src"
2926
],
3027
"scripts": {
31-
"ts:cjs": "tsc -p ts/cjs.tsconfig.json",
32-
"ts:esm": "tsc -p ts/esm.tsconfig.json",
33-
"ts:typedefs": "tsc -p ts/types.tsconfig.json && mv defs/* . && rimraf defs",
34-
"ts:all": "pnpm ts:esm && pnpm ts:cjs && pnpm ts:typedefs",
3528
"build": "pnpm clean && pnpm ts:all",
3629
"clean": "rimraf ./*.d.ts ./*.d.ts.map ./dist",
3730
"lint": "eslint src test",
38-
"prepublishOnly": "pnpm test && pnpm build",
3931
"prepare": "pnpm build",
32+
"prepublishOnly": "pnpm test && pnpm build",
4033
"postpublish": "pnpm clean",
41-
"release": "release-it",
4234
"test": "jest",
43-
"test:watch": "jest --watch"
35+
"test:watch": "jest --watch",
36+
"ts:all": "pnpm ts:esm && pnpm ts:cjs && pnpm ts:typedefs",
37+
"ts:cjs": "tsc -p ts/cjs.tsconfig.json",
38+
"ts:esm": "tsc -p ts/esm.tsconfig.json",
39+
"ts:typedefs": "tsc -p ts/types.tsconfig.json && mv defs/* . && rimraf defs"
40+
},
41+
"dependencies": {
42+
"@babel/core": "^7.16.10",
43+
"@babel/plugin-syntax-decorators": "^7.16.7",
44+
"@babel/plugin-transform-typescript": "^7.16.8",
45+
"prettier": "^2.5.1"
4446
},
4547
"devDependencies": {
4648
"@types/babel__core": "^7.1.18",
@@ -52,19 +54,13 @@
5254
"eslint-config-prettier": "^8.3.0",
5355
"eslint-plugin-prettier": "^4.0.0",
5456
"jest": "^27.4.7",
55-
"release-it": "^14.12.4",
57+
"release-plan": "^0.9.0",
5658
"rimraf": "^3.0.2",
5759
"ts-jest": "^27.1.3",
5860
"typescript": "^4.5.5"
5961
},
60-
"dependencies": {
61-
"@babel/core": "^7.16.10",
62-
"@babel/plugin-syntax-decorators": "^7.16.7",
63-
"@babel/plugin-transform-typescript": "^7.16.8",
64-
"prettier": "^2.5.1"
65-
},
66-
"release-it": {
67-
"github": true
68-
},
69-
"packageManager": "[email protected]+sha512.0a203ffaed5a3f63242cd064c8fb5892366c103e328079318f78062f24ea8c9d50bc6a47aa3567cabefd824d170e78fa2745ed1f16b132e16436146b7688f19b"
62+
"packageManager": "[email protected]+sha512.0a203ffaed5a3f63242cd064c8fb5892366c103e328079318f78062f24ea8c9d50bc6a47aa3567cabefd824d170e78fa2745ed1f16b132e16436146b7688f19b",
63+
"publishConfig": {
64+
"registry": "https://registry.npmjs.org/"
65+
}
7066
}

0 commit comments

Comments
 (0)