Skip to content

Commit 29f8f86

Browse files
gpongelliLee-W
authored andcommitted
align all to gpg_sign
1 parent d309a02 commit 29f8f86

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

commitizen/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@
161161
"action": "store_true",
162162
},
163163
{
164-
"name": ["--sign", "-s"],
164+
"name": ["--gpg-sign", "-s"],
165165
"help": "sign tag instead of lightweight one",
166166
"default": False,
167167
"action": "store_true",

docs/bump.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ options:
8282
--check-consistency, -cc
8383
check consistency among versions defined in commitizen
8484
configuration and version_files
85-
--sign, -s create a signed tag instead of lightweight one or annotated tag
85+
--gpg-sign, -s create a signed tag instead of lightweight one or annotated tag
8686
--annotated-tag, -at create annotated tag instead of lightweight one
8787
--changelog-to-stdout
8888
Output changelog to the stdout

docs/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,13 @@ commitizen:
123123
## Settings
124124
125125
| Variable | Type | Default | Description |
126-
| -------------------------- | ------ | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
126+
|----------------------------| ------ | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
127127
| `name` | `str` | `"cz_conventional_commits"` | Name of the committing rules to use |
128128
| `version` | `str` | `None` | Current version. Example: "0.1.2" |
129129
| `version_files` | `list` | `[ ]` | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more][version_files] |
130130
| `tag_format` | `str` | `None` | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more][tag_format] |
131131
| `update_changelog_on_bump` | `bool` | `false` | Create changelog when running `cz bump` |
132-
| `sign` | `bool` | `false` | Use gpg signed tags instead of lightweight tags. |
132+
| `gpg_sign` | `bool` | `false` | Use gpg signed tags instead of lightweight tags. |
133133
| `annotated_tag` | `bool` | `false` | Use annotated tags instead of lightweight tags. [See difference][annotated-tags-vs-lightweight] |
134134
| `bump_message` | `str` | `None` | Create custom commit message, useful to skip ci. [See more][bump_message] |
135135
| `allow_abort` | `bool` | `false` | Disallow empty commit messages, useful in ci. [See more][allow_abort] |

0 commit comments

Comments
 (0)