From 046a8824766e7753aa90e1946d14c5274ef7fa9d Mon Sep 17 00:00:00 2001 From: Mike Penz Date: Sun, 31 Jan 2021 09:58:29 +0100 Subject: [PATCH] - add note about toTag resolval - FIX https://github.com/mikepenz/release-changelog-builder-action/issues/170 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9bc23f2..8ebe299 100644 --- a/README.md +++ b/README.md @@ -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