Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

Commit

Permalink
docs: clarify changelog-types and its implications to version bumps (…
Browse files Browse the repository at this point in the history
…#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>
  • Loading branch information
stutommi and chingor13 committed Nov 6, 2023
1 parent ca61f37 commit d7869d8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Automate releases with Conventional Commit Messages.
| `bump-patch-for-minor-pre-major` | Should feat changes before 1.0.0 produce patch bumps instead of minor bumps? Default `false` |
| `path` | create a release from a path other than the repository's root |
| `monorepo-tags` | add prefix to tags and branches, allowing multiple libraries to be released from the same repository. |
| `changelog-types` | A JSON formatted String containing to override the outputted changelog sections |
| `changelog-types` | A JSON formatted String containing to override the outputted changelog sections. Defined types may trigger version bumps. |
| `version-file` | provide a path to a version file to increment (used by ruby releaser) |
| `extra-files` | add extra-files to bump using the [generic updater](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files) |
| `fork` | Should the PR be created from a fork. Default `false` |
Expand Down

0 comments on commit d7869d8

Please sign in to comment.