Skip to content

Commit

Permalink
start using release-plan
Browse files Browse the repository at this point in the history
  • Loading branch information
mansona committed Nov 15, 2024
1 parent d773650 commit c31fce6
Showing 5 changed files with 1,017 additions and 315 deletions.
90 changes: 90 additions & 0 deletions .github/workflows/plan-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
name: Release Plan Review
on:
push:
branches:
- main
- master
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/
types:
- labeled
- unlabeled

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

jobs:
check-plan:
name: "Check Release Plan"
runs-on: ubuntu-latest
outputs:
command: ${{ steps.check-release.outputs.command }}

steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
ref: 'master'
# This will only cause the `check-plan` job to have a "command" of `release`
# when the .release-plan.json file was changed on the last commit.
- id: check-release
run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT

prepare_release_notes:
name: Prepare Release Notes
runs-on: ubuntu-latest
timeout-minutes: 5
needs: check-plan
permissions:
contents: write
issues: read
pull-requests: write
outputs:
explanation: ${{ steps.explanation.outputs.text }}
# only run on push event if plan wasn't updated (don't create a release plan when we're releasing)
# only run on labeled event if the PR has already been merged
if: (github.event_name == 'push' && needs.check-plan.outputs.command != 'release') || (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true)

steps:
- uses: actions/checkout@v4
# We need to download lots of history so that
# github-changelog can discover what's changed since the last release
with:
fetch-depth: 0
ref: 'master'
- uses: actions/setup-node@v4
with:
node-version: 18
- uses: pnpm/action-setup@v4
- run: pnpm install --frozen-lockfile
- name: "Generate Explanation and Prep Changelogs"
id: explanation
run: |
set +e
pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
if [ $? -ne 0 ]; then
echo 'text<<EOF' >> $GITHUB_OUTPUT
cat release-plan-stderr.txt >> $GITHUB_OUTPUT
echo 'EOF' >> $GITHUB_OUTPUT
else
echo 'text<<EOF' >> $GITHUB_OUTPUT
jq .description .release-plan.json -r >> $GITHUB_OUTPUT
echo 'EOF' >> $GITHUB_OUTPUT
rm release-plan-stderr.txt
fi
env:
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}

- uses: peter-evans/create-pull-request@v6
with:
commit-message: "Prepare Release using 'release-plan'"
labels: "internal"
branch: release-preview
title: Prepare Release
body: |
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 👍
-----------------------------------------
${{ steps.explanation.outputs.text }}
58 changes: 58 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# For every push to the master branch, this checks if the release-plan was
# updated and if it was it will publish stable npm packages based on the
# release plan

name: Publish Stable

on:
workflow_dispatch:
push:
branches:
- main
- master

concurrency:
group: publish-${{ github.head_ref || github.ref }}
cancel-in-progress: true

jobs:
check-plan:
name: "Check Release Plan"
runs-on: ubuntu-latest
outputs:
command: ${{ steps.check-release.outputs.command }}

steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
ref: 'master'
# This will only cause the `check-plan` job to have a result of `success`
# when the .release-plan.json file was changed on the last commit. This
# plus the fact that this action only runs on main will be enough of a guard
- id: check-release
run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT

publish:
name: "NPM Publish"
runs-on: ubuntu-latest
needs: check-plan
if: needs.check-plan.outputs.command == 'release'
permissions:
contents: write
pull-requests: write

steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
registry-url: 'https://registry.npmjs.org'
- uses: pnpm/action-setup@v4
- run: pnpm install --frozen-lockfile
- name: npm publish
run: pnpm release-plan publish
env:
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
27 changes: 27 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Release Process

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.

## Preparation

Since the majority of the actual release process is automated, the remaining tasks before releasing are:

- correctly labeling **all** pull requests that have been merged since the last release
- updating pull request titles so they make sense to our users

Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
guiding principle here is that changelogs are for humans, not machines.

When reviewing merged PR's the labels to be used are:

* breaking - Used when the PR is considered a breaking change.
* enhancement - Used when the PR adds a new feature or enhancement.
* bug - Used when the PR fixes a bug included in a previous release.
* documentation - Used when the PR adds or updates documentation.
* internal - Internal changes or things that don't fit in any other category.

**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`

## Release

Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/Mainmatter/ember-hbs-minifier/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR
19 changes: 10 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -9,20 +9,20 @@
"repository": "github:Mainmatter/ember-hbs-minifier",
"license": "MIT",
"author": "Mainmatter GmbH <[email protected]>",
"directories": {
"doc": "doc",
"test": "tests"
},
"files": [
"hbs-minifier-plugin.js",
"index.js",
"utils"
],
"directories": {
"doc": "doc",
"test": "tests"
},
"scripts": {
"build": "ember build",
"changelog": "lerna-changelog",
"lint": "eslint . --cache",
"format": "prettier . --write",
"lint": "eslint . --cache",
"start": "ember server",
"test": "jest",
"test:ember": "ember test"
@@ -38,11 +38,11 @@
"@ember/test-helpers": "2.9.3",
"@glimmer/component": "^1.1.2",
"@glimmer/syntax": "0.84.3",
"@glimmer/syntax-0.92.3": "npm:@glimmer/[email protected]",
"@glimmer/syntax-0.35.11": "npm:@glimmer/[email protected]",
"@glimmer/syntax-0.37.1": "npm:@glimmer/[email protected]",
"@glimmer/syntax-0.40.1": "npm:@glimmer/[email protected]",
"@glimmer/syntax-0.62.5": "npm:@glimmer/[email protected]",
"@glimmer/syntax-0.92.3": "npm:@glimmer/[email protected]",
"ember-auto-import": "^2.8.1",
"ember-cli": "4.10.0",
"ember-cli-babel": "7.26.11",
@@ -64,12 +64,16 @@
"loader.js": "4.7.0",
"prettier": "^2.0.0",
"qunit": "2.19.4",
"release-plan": "^0.9.0",
"webpack": "5.82.1"
},
"packageManager": "[email protected]+sha512.3ede4912357625239102ac3f5ed8df178937e0f050169a95de450c1584a5cab589b22a391ebde5ab2da8264a69accad56cec8126cc577d90d03a5be6cad22b80",
"engines": {
"node": "12.* || 14.* || >= 16.*"
},
"changelog": {
"repo": "Mainmatter/ember-hbs-minifier"
},
"ember": {
"edition": "octane"
},
@@ -82,8 +86,5 @@
"versionCompatibility": {
"ember": "~3.20.0 || ~3.24.0 || ~3.28.0 || ~4.4.0 || ~4.8.0 || ~4.12.0 || ~5.4.0 || ~5.8.0 || ~5.12.0 || >= 6.0.0"
}
},
"changelog": {
"repo": "Mainmatter/ember-hbs-minifier"
}
}
Loading

0 comments on commit c31fce6

Please sign in to comment.