Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: commitizen-tools/commitizen-action
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 5b0848c
Choose a base ref
...
head repository: commitizen-tools/commitizen-action
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 128a04e
Choose a head ref
  • 1 commit
  • 1 file changed
  • 1 contributor

Commits on Mar 3, 2023

  1. docs(README): add missing inputs 

    Closes #45
    @woile
    woile committed Mar 3, 2023
    Copy the full SHA
    128a04e View commit details
Showing with 7 additions and 4 deletions.
  1. +7 −4 README.md
11 changes: 7 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -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