docs: record the setting release-please needs to open a PR #16
This file contains hidden or 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 PR | |
| # Maintains an open "chore(main): release x.y.z" pull request that accumulates every | |
| # merged change, derives the next version from the conventional-commit history, and | |
| # rewrites CHANGELOG.md. Nothing is versioned or tagged until that PR is merged. | |
| # | |
| # Chosen over fully automatic publishing on purpose: releasing is irreversible on npm, | |
| # so there is a human gate. Merging the release PR tags the commit; the actual | |
| # `npm publish` stays in release.yml, which is manual. | |
| on: | |
| push: | |
| branches: [main] | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| jobs: | |
| release-please: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: googleapis/release-please-action@v5 | |
| with: | |
| # Configuration lives in release-please-config.json and the current version | |
| # in .release-please-manifest.json. Without the manifest the action logs | |
| # 'No version for path .' and never opens a release PR — it cannot know | |
| # what the previous version was, since no release has ever been tagged. | |
| config-file: release-please-config.json | |
| manifest-file: .release-please-manifest.json |