Skip to content

Commit c8bd9bd

Browse files
Kurt-von-LavenKurt-von-Laven
committed
docs: Run markdown-table-formatter on README
Fix Markdown table column alignment. Refer to https://github.com/nvuillam/markdown-table-formatter.
1 parent f796cff commit c8bd9bd

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

‎README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -64,27 +64,27 @@ jobs:
6464
6565
## Variables
6666
67-
| Name | Description | Default |
68-
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
69-
| `github_token` | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}` **required** | - |
70-
| `dry_run` | Run without creating commit, output to stdout | false |
71-
| `repository` | Repository name to push. Default or empty value represents current github repository | current one |
72-
| `branch` | Destination branch to push changes | Same as the one executing the action by default |
73-
| `prerelease` | Set as prerelease {alpha,beta,rc} choose type of prerelease | - |
74-
| `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'` | - |
75-
| `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` | - |
76-
| `git_name` | Name used to configure git (for git operations) | `github-actions[bot]` |
77-
| `git_email` | Email address used to configure git (for git operations) | `github-actions[bot]@users.noreply.github.com` |
78-
| `push` | Define if the changes should be pushed to the branch. | true |
79-
| `commit` | Define if the changes should be committed to the branch. | true |
80-
| `commitizen_version` | Specify the version to be used by commitizen. Eg: `2.21.0` | latest |
81-
| `changelog` | Create changelog when bumping the version | true |
67+
| Name | Description | Default |
68+
|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
69+
| `github_token` | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}` **required** | - |
70+
| `dry_run` | Run without creating commit, output to stdout | false |
71+
| `repository` | Repository name to push. Default or empty value represents current github repository | current one |
72+
| `branch` | Destination branch to push changes | Same as the one executing the action by default |
73+
| `prerelease` | Set as prerelease {alpha,beta,rc} choose type of prerelease | - |
74+
| `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'` | - |
75+
| `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` | - |
76+
| `git_name` | Name used to configure git (for git operations) | `github-actions[bot]` |
77+
| `git_email` | Email address used to configure git (for git operations) | `github-actions[bot]@users.noreply.github.com` |
78+
| `push` | Define if the changes should be pushed to the branch. | true |
79+
| `commit` | Define if the changes should be committed to the branch. | true |
80+
| `commitizen_version` | Specify the version to be used by commitizen. Eg: `2.21.0` | latest |
81+
| `changelog` | Create changelog when bumping the version | true |
8282
| `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/) |
8383

8484
## Outputs
8585

8686
| Name | Description |
87-
| --------- | --------------- |
87+
|-----------|-----------------|
8888
| `version` | The new version |
8989

9090
Additionally, the new version is also available as an environment variable under `REVISION`.

0 commit comments

Comments
 (0)