Skip to content

Commit 27a2466

Browse files
mansonamansona
committed
setup release-plan
1 parent 2fa75b3 commit 27a2466

6 files changed

Lines changed: 3466 additions & 19 deletions

File tree

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
should-run-release-plan-prepare:
19+
name: Should we run release-plan prepare?
20+
runs-on: ubuntu-latest
21+
outputs:
22+
should-prepare: ${{ steps.should-prepare.outputs.should-prepare }}
23+
steps:
24+
- uses: release-plan/actions/should-prepare-release@v1
25+
with:
26+
ref: 'master'
27+
id: should-prepare
28+
29+
create-prepare-release-pr:
30+
name: Create Prepare Release PR
31+
runs-on: ubuntu-latest
32+
timeout-minutes: 5
33+
needs: should-run-release-plan-prepare
34+
permissions:
35+
contents: write
36+
issues: read
37+
pull-requests: write
38+
if: needs.should-run-release-plan-prepare.outputs.should-prepare == 'true'
39+
steps:
40+
- uses: release-plan/actions/prepare@v1
41+
name: Run release-plan prepare
42+
with:
43+
ref: 'master'
44+
env:
45+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
46+
id: explanation
47+
48+
- uses: peter-evans/create-pull-request@v8
49+
name: Create Prepare Release PR
50+
with:
51+
commit-message: "Prepare Release ${{ steps.explanation.outputs.new-version}} using 'release-plan'"
52+
labels: "internal"
53+
sign-commits: true
54+
branch: release-preview
55+
title: Prepare Release ${{ steps.explanation.outputs.new-version }}
56+
body: |
57+
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 👍
58+
59+
-----------------------------------------
60+
61+
${{ steps.explanation.outputs.text }}

‎.github/workflows/publish.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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+
id-token: write
26+
attestations: write
27+
28+
steps:
29+
- uses: actions/checkout@v6
30+
- uses: pnpm/action-setup@v5
31+
- uses: actions/setup-node@v6
32+
with:
33+
node-version: 24
34+
registry-url: 'https://registry.npmjs.org'
35+
cache: pnpm
36+
- run: pnpm install --frozen-lockfile
37+
- name: Publish to NPM
38+
run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish
39+
env:
40+
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}

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

‎package.json‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
{
22
"name": "broccoli-middleware",
3-
"description": "Broccoli asset builder middleware",
43
"version": "2.1.1",
5-
"author": "Jo Liss <joliss42@gmail.com>",
6-
"main": "lib/index.js",
7-
"license": "MIT",
4+
"description": "Broccoli asset builder middleware",
85
"keywords": [
96
"builder",
107
"build",
@@ -13,11 +10,18 @@
1310
"asset",
1411
"pipeline"
1512
],
13+
"homepage": "https://github.com/ember-cli/broccoli-middleware",
1614
"repository": {
1715
"type": "git",
1816
"url": "https://github.com/ember-cli/broccoli-middleware"
1917
},
20-
"homepage": "https://github.com/ember-cli/broccoli-middleware",
18+
"license": "MIT",
19+
"author": "Jo Liss <joliss42@gmail.com>",
20+
"main": "lib/index.js",
21+
"scripts": {
22+
"lint": "eslint .",
23+
"test": "mocha"
24+
},
2125
"dependencies": {
2226
"ansi-html": "^0.0.7",
2327
"find-up": "^3.0.0",
@@ -33,15 +37,12 @@
3337
"express": "^4.13.4",
3438
"jshint": "~2.9.4",
3539
"mocha": "^5.0.0",
40+
"release-plan": "^0.18.0",
3641
"request-promise": "^3.0.0",
3742
"rsvp": "^4.6.1"
3843
},
44+
"packageManager": "pnpm@10.33.4+sha512.1c67b3b359b2d408119ba1ed289f34b8fc3c6873412bec6fd264fbdc82489e510fcbecb9ce9d22dae7f3b76269d8441046014bdca53b9979cd7a561ad631b800",
3945
"engines": {
4046
"node": "6.* || 8.* || >= 10.*"
41-
},
42-
"scripts": {
43-
"test": "mocha",
44-
"lint": "eslint ."
45-
},
46-
"packageManager": "pnpm@10.33.4+sha512.1c67b3b359b2d408119ba1ed289f34b8fc3c6873412bec6fd264fbdc82489e510fcbecb9ce9d22dae7f3b76269d8441046014bdca53b9979cd7a561ad631b800"
47+
}
4748
}

0 commit comments

Comments
 (0)