actions/gitea-release-please-action
1
0
Fork 0
mirror of https://github.com/joaquinjsb/gitea-release-please-action synced 2026-05-05 10:37:47 +02:00
Code Activity

docs: clarify changelog-types and its implications to version bumps (#844)

Browse Source 
<!--
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](https://github.com/googleapis/release-please/issues/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>
This commit is contained in:
Tommi Tampio
2023-11-06 23:20:54 +02:00
committed by GitHub
parent ca61f372ac
commit d7869d8d45
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -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` |