meta: add release-please-action for automated releases
#2395
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| name: release-please | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
|
|
||
| jobs: | ||
| release-please: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: google-github-actions/release-please-action@v2 | ||
| id: release | ||
| with: | ||
| package-name: node-gyp | ||
| release-type: node | ||
| changelog-types: > | ||
| [{"type":"feat","section":"Features","hidden":false}, | ||
| {"type":"fix","section":"Bug Fixes","hidden":false}, | ||
| {"type":"bin","section":"Core","hidden":false}, | ||
| {"type":"gyp","section":"Core","hidden":false}, | ||
| {"type":"lib","section":"Core","hidden":false}, | ||
| {"type":"src","section":"Core","hidden":false}, | ||
| {"type":"test","section":"Tests","hidden":false}, | ||
| {"type":"build","section":"Core","hidden":false}, | ||
| {"type":"clean","section":"Core","hidden":false}, | ||
| {"type":"configure","section":"Core","hidden":false}, | ||
| {"type":"install","section":"Core","hidden":false}, | ||
| {"type":"list","section":"Core","hidden":false}, | ||
| {"type":"rebuild","section":"Core","hidden":false}, | ||
| {"type":"remove","section":"Core","hidden":false}, | ||
| {"type":"deps","section":"Core","hidden":false}, | ||
| {"type":"python","section":"Core","hidden":false}, | ||
| {"type":"lin","section":"Core","hidden":false}, | ||
| {"type":"linux","section":"Core","hidden":false}, | ||
| {"type":"mac","section":"Core","hidden":false}, | ||
| {"type":"macos","section":"Core","hidden":false}, | ||
| {"type":"win","section":"Core","hidden":false}, | ||
| {"type":"windows","section":"Core","hidden":false}, | ||
| {"type":"zos","section":"Core","hidden":false}, | ||
| {"type":"doc","section":"Doc","hidden":false}, | ||
| {"type":"docs","section":"Doc","hidden":false}, | ||
| {"type":"readme","section":"Doc","hidden":false}, | ||
| {"type":"chore","section":"Miscellaneous","hidden":false}, | ||
| {"type":"refactor","section":"Miscellaneous","hidden":false}, | ||
| {"type":"ci","section":"Miscellaneous","hidden":false}, | ||
| {"type":"meta","section":"Miscellaneous","hidden":false}] | ||
|
|
||
| # Standard Conventional Commits: `feat` and `fix` | ||
| # node-gyp subdirectories: `bin`, `gyp`, `lib`, `src`, `test` | ||
| # node-gyp subcommands: `build`, `clean`, `configure`, `install`, `list`, `rebuild`, `remove` | ||
| # Core abstract category: `deps` | ||
| # Languages/platforms: `python`, `lin`, `linux`, `mac`, `macos`, `win`, `window`, `zos` | ||
| # Documentation: `doc`, `docs`, `readme` | ||
| # Standard Conventional Commits: `chore` (under "Miscellaneous") | ||
| # Miscellaneous abstract categories: `refactor`, `ci`, `meta` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could link to Electron's commit message guidelines, which are a lot like Node's (forked docs based on NodeJS's docs), but based around Conventional Commits: https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines
On the other hand, emphasizing
fix:feat:andBREAKING-CHANGE:semver hints would help for the release proposal PRs to know whether to bump patch, minor or major. Maybe we should have our own docs page about this?For dealing with semver manually,
release-please-actioncan be told to release a specific version, by posting a commit with aRelease-As: x.y.zfooter: https://github.com/googleapis/release-please/tree/v11.11.0#how-do-i-change-the-version-number. So maintainers can just do that and not worry very much about individual commit messages, if the need arises.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe link to
release-please.yml.