From 32d23197d5103f34c8e9f0c2aec223a383ed0dd0 Mon Sep 17 00:00:00 2001 From: Mike Penz Date: Sun, 18 Oct 2020 10:35:37 +0200 Subject: [PATCH] - add better table to describe input configuration options --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a142fc..0ff4b92 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,18 @@ For advanced usecases additional settings can be provided to the action token: ${{ secrets.PAT }} ``` -💡 `ignorePreReleases` will be ignored, if `fromTag` is specified. `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repos please use a PAT (Personal Access Token). +| **Input** | **Description** | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| configuration | Relative path, to the `configuration.json` file, providing additional configurations | +| owner | The owner of the repository to generate the changelog for | +| repo | Name of the repository we want to process | +| ignorePreReleases | Allows to ignore pre-releases for changelog generation (E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick). Only used if `fromTag` was not specified. Default: false | +| fromTag | Defines the 'start' from where the changelog will consider merged pull requests | +| toTag | Defines until which tag the changelog will consider merged pull requests | +| path | Allows to specify an alternative sub directory, to use as base | +| token | Alternative config to specify token. You should prefer `env.GITHUB_TOKEN` instead though | + +💡 `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repos please use a PAT (Personal Access Token). ### PR Template placeholders