diff --git a/README.md b/README.md index 25eb555..06d4b0d 100644 --- a/README.md +++ b/README.md @@ -125,13 +125,13 @@ jobs: ### 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. +> **Warning**: 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`). +> **Note**: 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. +> **Note**: 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 @@ -146,7 +146,7 @@ The action supports flexible configuration options to modify vast areas of its b GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` -⚠️ Please note: It is required to have a `checkout` step prior to the changelog step, to allow the action to discover the configuration file. +> **Warning** It is required to have a `checkout` step prior to the changelog step, to allow the action to discover the configuration file. This configuration is a `.json` file in the following format. @@ -226,7 +226,7 @@ This configuration is a `.json` file in the following format. Any section of the configuration can be omitted to have defaults apply. -💡 `ignore_labels` take precedence over category labels, allowing to specifically exclude certain PRs. +> **Warning**: `ignore_labels` take precedence over category labels, allowing to specifically exclude certain PRs. Defaults for the configuration can be found in the [configuration.ts](https://github.com/mikepenz/release-changelog-builder-action/blob/develop/src/configuration.ts) @@ -251,7 +251,7 @@ For advanced use cases additional settings can be provided to the action token: ${{ secrets.PAT }} ``` -💡 All input values are optional. It is only required to provide the `token` either via the input, or as `env` variable. +> **Note**: All input values are optional. It is only required to provide the `token` either via the input, or as `env` variable. | **Input** | **Description** | |-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -270,7 +270,7 @@ For advanced use cases additional settings can be provided to the action | `fetchReviewers` | Will enable fetching the users/reviewers who approved the PR. Default: false | | `commitMode` | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. Default: false | -💡 `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repositories please use a PAT (Personal Access Token). +> **Warning**: `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repositories please use a PAT (Personal Access Token). ### PR Template placeholders