Skip to content

Commit e65baf0

Browse files
authored
docs(README): add missing inputs (#63)
Closes #45
1 parent 95c0820 commit e65baf0

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

Diff for: README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -81,15 +81,18 @@ jobs:
8181
| `commitizen_version` | Specify the version to be used by commitizen. Eg: `2.21. | latest |
8282
| `changelog` | Create changelog when bumping the version | true |
8383
| `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/) |
84-
| `increment` | Manually specify the desired increment {MAJOR,MINOR,PATCH} | - |
84+
| `increment` | Manually specify the desired increment {MAJOR,MINOR, PATCH} | - |
85+
| `check_consistency` | Check consistency among versions defined in commitizen configuration and version_files | `false` |
86+
| `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` |
87+
| `debug` | Prints debug output to GitHub Actions stdout | `false` |
8588

8689
## Outputs
8790

8891
| Name | Description |
89-
|-----------|-----------------|
92+
| --------- | --------------- |
9093
| `version` | The new version |
9194

92-
Additionally, the new version is also available as an environment variable under `REVISION`.
95+
The new version is also available as an environment variable under `REVISION` or you can access using `${{ steps.cz.outputs.version }}`
9396

9497
## Troubleshooting
9598

@@ -100,7 +103,7 @@ actions [by design][by_design].
100103

101104
To solve it, you must use a personal access token in the checkout and the commitizen steps.
102105

103-
Follow the instructions in [commitizen's documentation][cz-docs-ga]
106+
Follow the instructions in [commitizen's documentation][cz-docs-ga].
104107

105108
## I'm not using conventional commits, I'm using my own set of rules on commits
106109

0 commit comments

Comments
 (0)