Skip to content

Commit bdbbd36

Browse files
SergeAstapovSergeAstapov
committed
Setup release-plan
1 parent 57b2a84 commit bdbbd36

File tree

6 files changed

+1274
-33
lines changed

6 files changed

+1274
-33
lines changed

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Plan Release
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- main
7+
- master
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:
10+
- labeled
11+
- unlabeled
12+
13+
concurrency:
14+
group: plan-release # only the latest one of these should ever be running
15+
cancel-in-progress: true
16+
17+
jobs:
18+
is-this-a-release:
19+
name: "Is this a release?"
20+
runs-on: ubuntu-latest
21+
outputs:
22+
command: ${{ steps.check-release.outputs.command }}
23+
24+
steps:
25+
- uses: actions/checkout@v4
26+
with:
27+
fetch-depth: 2
28+
ref: 'main'
29+
# This will only cause the `is-this-a-release` job to have a "command" of `release`
30+
# when the .release-plan.json file was changed on the last commit.
31+
- id: check-release
32+
run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
33+
34+
create-prepare-release-pr:
35+
name: Create Prepare Release PR
36+
runs-on: ubuntu-latest
37+
timeout-minutes: 5
38+
needs: is-this-a-release
39+
permissions:
40+
contents: write
41+
issues: read
42+
pull-requests: write
43+
# only run on push event or workflow dispatch 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' || 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)
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: 'main'
54+
- uses: actions/setup-node@v4
55+
with:
56+
node-version: 18
57+
- run: npm ci
58+
- name: "Generate Explanation and Prep Changelogs"
59+
id: explanation
60+
run: |
61+
set +e
62+
npx release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
63+
64+
if [ $? -ne 0 ]; then
65+
release_plan_output=$(cat release-plan-stderr.txt)
66+
else
67+
release_plan_output=$(jq .description .release-plan.json -r)
68+
rm release-plan-stderr.txt
69+
70+
if [ $(jq '.solution | length' .release-plan.json) -eq 1 ]; then
71+
new_version=$(jq -r '.solution[].newVersion' .release-plan.json)
72+
echo "new_version=v$new_version" >> $GITHUB_OUTPUT
73+
fi
74+
fi
75+
echo 'text<<EOF' >> $GITHUB_OUTPUT
76+
echo "$release_plan_output" >> $GITHUB_OUTPUT
77+
echo 'EOF' >> $GITHUB_OUTPUT
78+
env:
79+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
80+
81+
- uses: peter-evans/create-pull-request@v7
82+
with:
83+
commit-message: "Prepare Release ${{ steps.explanation.outputs.new_version}} using 'release-plan'"
84+
labels: "internal"
85+
branch: release-preview
86+
title: Prepare Release ${{ steps.explanation.outputs.new_version }}
87+
body: |
88+
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 👍
89+
90+
-----------------------------------------
91+
92+
${{ steps.explanation.outputs.text }}

‎.github/workflows/publish.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# For every push to the primary branch with .release-plan.json modified,
2+
# runs release-plan.
3+
4+
name: Publish Stable
5+
6+
on:
7+
workflow_dispatch:
8+
push:
9+
branches:
10+
- main
11+
- master
12+
paths:
13+
- '.release-plan.json'
14+
15+
concurrency:
16+
group: publish-${{ github.head_ref || github.ref }}
17+
cancel-in-progress: true
18+
19+
jobs:
20+
publish:
21+
name: "NPM Publish"
22+
runs-on: ubuntu-latest
23+
permissions:
24+
contents: write
25+
pull-requests: write
26+
id-token: write
27+
attestations: write
28+
29+
steps:
30+
- uses: actions/checkout@v4
31+
- uses: actions/setup-node@v4
32+
with:
33+
node-version: 18
34+
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
35+
registry-url: 'https://registry.npmjs.org'
36+
- run: npm ci
37+
- name: Publish to NPM
38+
run: npx release-plan publish --provenance
39+
env:
40+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
41+
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/emberjs/ember-legacy-built-in-components/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

‎package.json‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
"ember-addon"
77
],
88
"homepage": "https://github.com/emberjs/ember-legacy-built-in-components",
9+
"bugs": {
10+
"url": "https://github.com/emberjs/ember-legacy-built-in-components/issues"
11+
},
912
"repository": {
1013
"type": "git",
1114
"url": "git+https://github.com/emberjs/ember-legacy-built-in-components.git"
1215
},
13-
"bugs": {
14-
"url": "https://github.com/emberjs/ember-legacy-built-in-components/issues"
15-
},
1616
"license": "MIT",
1717
"directories": {
1818
"doc": "doc",
@@ -98,20 +98,21 @@
9898
"prettier": "^2.4.0",
9999
"qunit": "^2.17.2",
100100
"qunit-dom": "^2.0.0",
101+
"release-plan": "^0.16.0",
101102
"typescript": "^4.5.5",
102103
"webpack": "^5.52.1"
103104
},
104105
"engines": {
105106
"node": ">= 16"
106107
},
108+
"volta": {
109+
"node": "20.19.1",
110+
"yarn": "1.22.22"
111+
},
107112
"ember": {
108113
"edition": "octane"
109114
},
110115
"ember-addon": {
111116
"configPath": "tests/dummy/config"
112-
},
113-
"volta": {
114-
"node": "16.14.0",
115-
"yarn": "1.22.17"
116117
}
117118
}

0 commit comments

Comments
 (0)