Skip to content

Commit 1346855

Browse files
authored
docs: document inputs to customize git config
1 parent 5477151 commit 1346855

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

Diff for: README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,17 @@ jobs:
6161
6262
## Variables
6363
64-
| Name | Description | Default |
65-
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
66-
| `github_token` | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}` **required** | - |
67-
| `dry_run` | Run without creating commit, output to stdout | false |
68-
| `repository` | Repository name to push. Default or empty value represents current github repository | current one |
69-
| `branch` | Destination branch to push changes | `master` |
70-
| `prerelease` | Set as prerelease {alpha,beta,rc} choose type of prerelease | - |
71-
| `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'` | - |
72-
| `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` | - |
64+
| Name | Description | Default |
65+
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
66+
| `github_token` | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}` **required** | - |
67+
| `dry_run` | Run without creating commit, output to stdout | false |
68+
| `repository` | Repository name to push. Default or empty value represents current github repository | current one |
69+
| `branch` | Destination branch to push changes | `master` |
70+
| `prerelease` | Set as prerelease {alpha,beta,rc} choose type of prerelease | - |
71+
| `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'` | - |
72+
| `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` | - |
73+
| `git_name` | Name used to configure git (for git operations) | `github-actions[bot]` |
74+
| `git_email` | Email address used to configure git (for git operations) | `github-actions[bot]@users.noreply.github.com` |
7375

7476
<!-- | `changelog` | Create changelog when bumping the version | true | -->
7577

0 commit comments

Comments
 (0)