npx create-release-plan-setup@latest --update #1
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Release Plan Review | |
| 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 | |
| permissions: | |
| contents: write | |
| 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' && 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: 'main' | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| - uses: pnpm/action-setup@v3 | |
| with: | |
| version: 8 | |
| - run: pnpm install --frozen-lockfile | |
| - name: "Generate Explanation and Prep Changelogs" | |
| id: explanation | |
| run: | | |
| set +e | |
| pnpm release-plan prepare 2> >(tee -a stderr.log >&2) | |
| if [ $? -ne 0 ]; then | |
| echo 'text<<EOF' >> $GITHUB_OUTPUT | |
| cat stderr.log >> $GITHUB_OUTPUT | |
| echo 'EOF' >> $GITHUB_OUTPUT | |
| else | |
| echo 'text<<EOF' >> $GITHUB_OUTPUT | |
| jq .description .release-plan.json -r >> $GITHUB_OUTPUT | |
| echo 'EOF' >> $GITHUB_OUTPUT | |
| 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 }} |