From 128a04eaae88d8314475ca742eb1806d81f025d9 Mon Sep 17 00:00:00 2001 From: Santiago Fraire Date: Fri, 3 Mar 2023 10:31:03 +0100 Subject: [PATCH] docs(README): add missing inputs Closes #45 --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e322585..397c53b 100644 --- a/README.md +++ b/README.md @@ -81,15 +81,18 @@ jobs: | `commitizen_version` | Specify the version to be used by commitizen. Eg: `2.21. | latest | | `changelog` | Create changelog when bumping the version | true | | `no_raise` | Don't raise the given comma-delimited exit codes (e.g., no_raise: '20,21'). Use with caution! Open an issue in [commitizen](https://github.com/commitizen-tools/commitizen/issues) if you need help thinking about your workflow. | [21](https://commitizen-tools.github.io/commitizen/exit_codes/) | -| `increment` | Manually specify the desired increment {MAJOR,MINOR,PATCH} | - | +| `increment` | Manually specify the desired increment {MAJOR,MINOR, PATCH} | - | +| `check_consistency` | Check consistency among versions defined in commitizen configuration and version_files | `false` | +| `gpg_sign` | If true, use GPG to sign commits and tags (for git operations). Requires separate setup of GPG key and passphrase in GitHub Actions (e.g. with the action `crazy-max/ghaction-import-gpg`) | `false` | +| `debug` | Prints debug output to GitHub Actions stdout | `false` | ## Outputs | Name | Description | -|-----------|-----------------| +| --------- | --------------- | | `version` | The new version | -Additionally, the new version is also available as an environment variable under `REVISION`. +The new version is also available as an environment variable under `REVISION` or you can access using `${{ steps.cz.outputs.version }}` ## Troubleshooting @@ -100,7 +103,7 @@ actions [by design][by_design]. To solve it, you must use a personal access token in the checkout and the commitizen steps. -Follow the instructions in [commitizen's documentation][cz-docs-ga] +Follow the instructions in [commitizen's documentation][cz-docs-ga]. ## I'm not using conventional commits, I'm using my own set of rules on commits