From 6e238ad569395f5dce8f32a5baaea869da1b4318 Mon Sep 17 00:00:00 2001 From: Mike Penz Date: Wed, 30 Nov 2022 10:28:52 +0100 Subject: [PATCH] Update README.md - be more explicit on outlining the outlined configuration in the README being an example, vs the defaults being specified in the `configuration.ts` file --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f391057..964e29d 100644 --- a/README.md +++ b/README.md @@ -193,9 +193,11 @@ The action supports flexible configuration options to modify vast areas of its b GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +> **Note** Defaults for the configuration can be found in the [configuration.ts](https://github.com/mikepenz/release-changelog-builder-action/blob/develop/src/configuration.ts) + > **Warning** It is required to have a `checkout` step prior to the changelog step if `configuration` is used, to allow the action to discover the configuration file. Use `configurationJson` as alternative. -This configuration is a `.json` file in the following format. +This configuration is a `.json` file in the following format. (The below shocases *example* configurations for all possible options. In most scenarios most of the settings will not be needed, and the defaults will be appropiate.) ```json { @@ -276,8 +278,6 @@ Any section of the configuration can be omitted to have defaults apply. > **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) - Please see the [Configuration Specification](#configuration-specification) for detailed descriptions on the offered configuration options. ### Advanced workflow specification