diff --git a/.github/workflows/release-plan-preview.yml b/.github/workflows/plan-release.yml similarity index 51% rename from .github/workflows/release-plan-preview.yml rename to .github/workflows/plan-release.yml index 74d3b64..5c1b48d 100644 --- a/.github/workflows/release-plan-preview.yml +++ b/.github/workflows/plan-release.yml @@ -3,14 +3,42 @@ on: push: branches: - main + - master + pull_request: + types: + - labeled + +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: 'main' + # 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 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' && github.event.pull_request.merged == true) steps: - uses: actions/checkout@v4 @@ -21,15 +49,19 @@ jobs: - uses: actions/setup-node@v4 with: node-version: 18 + - uses: pnpm/action-setup@v2 with: version: 8 - run: pnpm install --frozen-lockfile + - name: "Generate Explanation and Prep Changelogs" id: explanation run: | set -x + node ./dist/cli.js prepare --single-package=release-plan + echo 'text<> $GITHUB_OUTPUT jq .description .release-plan.json -r >> $GITHUB_OUTPUT echo 'EOF' >> $GITHUB_OUTPUT @@ -42,11 +74,9 @@ jobs: author: "github-actions[bot] " labels: "internal" branch: release-preview - title: Release Preview + title: Prepare Release body: | - Preview of the Release. - - See `.github/workflows/release-plan-preview.yml` for how this PR was created. + 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 👍 ----------------------------------------- diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 3961747..2474c07 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -9,6 +9,7 @@ on: push: branches: - main + - master concurrency: group: publish-${{ github.head_ref || github.ref }} @@ -22,7 +23,7 @@ jobs: command: ${{ steps.check-release.outputs.command }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: 0 ref: 'main' @@ -45,6 +46,7 @@ jobs: 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@v2 with: version: 8 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..af0b7df --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Edward Faulkner + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..83eb4c5 --- /dev/null +++ b/RELEASE.md @@ -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 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/embroider-build/release-plan/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR diff --git a/package.json b/package.json index 7a99b7a..cec76f2 100644 --- a/package.json +++ b/package.json @@ -2,17 +2,20 @@ "name": "release-plan", "version": "0.3.0", "description": "", + "keywords": [], + "repository": "https://github.com/embroider-build/release-plan", + "license": "MIT", + "author": "Edward Faulkner ", + "contributors": [ + "Chris Manson " + ], "type": "module", "bin": "./dist/cli.js", - "repository": "https://github.com/embroider-build/release-plan", "scripts": { - "prepare": "npm run build", "build": "tsc", + "prepare": "npm run build", "test": "echo \"Error: no test specified\" && exit 1" }, - "keywords": [], - "author": "", - "license": "ISC", "dependencies": { "@ef4/lerna-changelog": "^1.0.4", "@npmcli/package-json": "^5.0.0",