Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

docs(README): add missing inputs #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 3, 2023
Merged

docs(README): add missing inputs #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down