- add note about toTag resolval

- FIX https://github.com/mikepenz/release-changelog-builder-action/issues/170
2021-01-31 09:58:29 +01:00
parent e14f2df23b
commit 046a882476
1 changed files with 2 additions and 0 deletions
@@ -133,6 +133,8 @@ The action supports flexible configuration options to modify vast areas of its b

 💡 By default not specifying `fromTag` or `toTag` will resolve `toTag` from either the `ref` or alternatively fallback to the latest tag from git. `fromTag` is resolved by sorting tags using [semver](https://semver.org/). Check the [configuration](#configuration-specification) for alternatives.

+⚠️ When running this action for a non tags trigger the `toTag` can't be automatically resolved, as such it is either required to provide `toTag` directly, or to specify a different `fetch-depth:` with the checkout action to include tags.   
+
 This configuration is a `.json` file in the following format.

 ```json