-
Notifications
You must be signed in to change notification settings - Fork 356
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Setting changelog-type
to "github" results in a new release on any type of commit
#2096
Comments
I'm puzzled by the same issue, I can see that with the configuration (below), seems like atleast commits starting with "chore:" and "docs:" (and probably all the others aswell, haven't tested) result in release-please action generating patch bumps: name: release-please
on:
push:
branches:
- main
permissions:
contents: write
pull-requests: write
jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: google-github-actions/release-please-action@v3
with:
token: ${{ secrets.MY_TOKEN }}
release-type: go
bump-minor-pre-major: true
changelog-types: >
[
{ "type": "build", "section": "Build System", "hidden": false },
{ "type": "ci", "section": "Continuous Integration", "hidden": false },
{ "type": "chore", "section": "Miscellaneous Chores", "hidden": false },
{ "type": "docs", "section": "Documentation", "hidden": false },
{ "type": "feat", "section": "Features", "hidden": false },
{ "type": "fix", "section": "Bug Fixes", "hidden": false },
{ "type": "perf", "section": "Performance Improvements", "hidden": false },
{ "type": "revert", "section": "Reverts", "hidden": false },
{ "type": "refactor", "section": "Code Refactoring", "hidden": false },
{ "type": "style", "section": "Styles", "hidden": false },
{ "type": "test", "section": "Tests", "hidden": false }
] |
I dug through the code how Sorry @bodgit, I didn't have time to check |
If you use the GitHub changelog type, it defers building the changelog to GitHub's logic which ignores any |
…844) <!-- Thank you for proposing a pull request! Please note that SOME TESTS WILL LIKELY FAIL due to how GitHub exposes secrets in Pull Requests from forks. Someone from the team will review your Pull Request and respond. Please describe your change and any implementation details below. --> Relating to [release-please issue](googleapis/release-please#2096) I was surprised that adding different changelog types result in patch version bumps. I wasn't expecting this but going through the code it seemed to be expected but undocumented behavior. And this is why I would like to document the behavior here so other people know and can plan whether to use it or not. cheers! --------- Signed-off-by: Tommi Tampio <46082658+stutommi@users.noreply.github.com> Co-authored-by: Jeff Ching <chingor@google.com>
Environment details
release-please
version: Using v3 of the release-please-action so whatever version is used there.Steps to reproduce
See #2078 for the background. I found that with any type of commit/merged PR, release-please was generating a new release, even for just chore commits, which I thought shouldn't happen.
My
release-please-config.json
was originally this:I had added the
changelog-type
setting to see what the difference was in the generated changelog, removing it so myrelease-please-config.json
looks like this:And now normal behaviour is restored.
The text was updated successfully, but these errors were encountered: