Skip to content

Commit 34f36ec

Browse files
committed
chore: updated README
1 parent ddb24db commit 34f36ec

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,16 @@ jobs:
6565
## Variables
6666
6767
| Name | Description | Default |
68-
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
68+
| ------------------------------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
6969
| `github_token` | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}`. Required if `push: true` | - |
7070
| `working_directory` | Change to this directory before running | repo root directory |
7171
| `dry_run` | Run without creating commit, output to stdout | false |
7272
| `repository` | Repository name to push. Default or empty value represents current github repository | current one |
7373
| `branch` | Destination branch to push changes | Same as the one executing the action by default |
7474
| `prerelease` | Set as prerelease {alpha,beta,rc} choose type of prerelease | - |
75-
| `devrelease` | Non-negative integer for dev. release | - |
76-
| `local_version` | Bump only the local version portion | - |
77-
| `build_metadata` | Specifies additional metadata in the version string, creates a version like `1.1.2+yourmetadata` | - |
75+
| `devrelease` | Non-negative integer for dev. release | - |
76+
| `local_version` | Bump only the local version portion | - |
77+
| `build_metadata` | Specifies additional metadata in the version string, creates a version like `1.1.2+yourmetadata` | - |
7878
| `extra_requirements` | Custom requirements, if your project uses a custom rule or plugins, you can specify them separated by a space. E.g: `'commitizen-emoji conventional-JIRA'` | - |
7979
| `changelog_increment_filename` | Filename to store the incremented generated changelog. This is different to changelog as it only contains the changes for the just generated version. Example: `body.md` | - |
8080
| `git_redirect_stderr` | Redirect git output to stderr. Useful if you do not want git output in your changelog | `false` |
@@ -87,6 +87,7 @@ jobs:
8787
| `changelog` | Create changelog when bumping the version | true |
8888
| `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/) |
8989
| `increment` | Manually specify the desired increment {MAJOR,MINOR, PATCH} | - |
90+
| `increment_mode` | Specify the increment mode {linear, exact} | `linear` |
9091
| `check_consistency` | Check consistency among versions defined in commitizen configuration and version_files | `false` |
9192
| `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` |
9293
| `debug` | Prints debug output to GitHub Actions stdout | `false` |

0 commit comments

Comments
 (0)