From d9e44c3306bf167a5e60fdf5e8078f158c3f829d Mon Sep 17 00:00:00 2001 From: Mike Penz Date: Fri, 5 Nov 2021 08:21:19 +0100 Subject: [PATCH] - rephrase note section --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 07ac15b..39c429a 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,16 @@ jobs: ## Customization 🖍️ +### Note + +⚠️ When running this action for non tags trigger the `toTag` will be automatically resolved using the latest tag as retrieved by the git API. + +⚠️ The first release tag is a special case since there is no previous release the action can reference to. For this case, there are 2 options: +1. When checking out the source via `git` (E.g.: `actions/checkout`), the action will use the first commit. +2. Create a initial tag on the commit you want to begin a changelog from (for example `v0.0.1`). + +💡 By default not specifying `fromTag` or `toTag` will resolve `toTag` from either the `ref` or alternatively fallback to the latest tag from the git API. `fromTag` is resolved by sorting tags using [semver](https://semver.org/). Check the [configuration](#configuration-specification) for alternatives. + ### Configuration The action supports flexible configuration options to modify vast areas of its behavior. To do so, provide the configuration file to the workflow using the `configuration` setting. @@ -139,15 +149,6 @@ The action supports flexible configuration options to modify vast areas of its b ⚠️ Please note: It is required to have a `checkout` step prior to the changelog step, to allow the action to discover the configuration file. -⚠️ When running this action for a non tags trigger the `toTag` will be automatically resolved using the latest tag as retrieved by the git API. - -💡 By default not specifying `fromTag` or `toTag` will resolve `toTag` from either the `ref` or alternatively fallback to the latest tag from the git API. `fromTag` is resolved by sorting tags using [semver](https://semver.org/). Check the [configuration](#configuration-specification) for alternatives. - -⚠️ The first release tag is a special case since there is no previous release where a changelog can be built. -For this case, you generally have 2 options: -1. Create a temporary tag on the commit you want to begin a changelog (for example `v0.0.1`). -2. If you are checking out the source with `git` CLI (for example with `actions/checkout`), this action will identify the first commit and build a changelog from there. - This configuration is a `.json` file in the following format. ```json