Skip to content

Commit 56ec29a

Browse files
committed
wip
1 parent 6ab9e3e commit 56ec29a

File tree

4 files changed

+43
-39
lines changed

4 files changed

+43
-39
lines changed

docs/config/bump.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Bump Options
2+
3+
## `version_files`
4+
5+
- Type: `list`
6+
- Default: `[]`
7+
8+
Files (or glob patterns) where the version will be updated. A pattern to match a line, can also be specified, separated by `:`.
9+
See [Version Files](../commands/bump.md#version_files) for more details.
10+
11+
12+
## `version_scheme`
13+
14+
- Type: `str`
15+
- Default: `pep440`
16+
17+
Select a version scheme from the following options:
18+
19+
- `pep440`
20+
- `semver`
21+
- `semver2`
22+
23+
Useful for non-python projects. See [Version Schemes](../commands/bump.md#version-schemes-version-scheme) for more details.
24+
25+
26+
### `tag_format`
27+
28+
- Type: `str`
29+
- Default: `$version`
30+
31+
Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [Read more][tag_format]
32+
33+
### `legacy_tag_formats`
34+
35+
- Type: `list`
36+
- Default: `[]`
37+
38+
Legacy git tag formats, useful for old projects that changed tag format.
39+
Tags matching those formats will be recognized as version tags and be included in the changelog.
40+
Each entry uses the syntax as [`tag_format`](#tag_format). [Read more][tag_format]

docs/config/option.md

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -16,48 +16,12 @@ Name of the committing rules to use.
1616

1717
Current version. Example: `"0.1.2"`. Required if you use `version_provider = "commitizen"`.
1818

19-
### `version_files`
20-
21-
- Type: `list`
22-
- Default: `[]`
23-
24-
Files (or glob patterns) where the version will be updated. A pattern to match a line, can also be specified, separated by `:` [Read more][version_files]
25-
2619
### `version_provider`
2720

2821
- Type: `str`
2922
- Default: `commitizen`
3023

31-
Version provider used to read and write version. [Read more][version-provider]
32-
33-
### `version_scheme`
34-
35-
- Type: `str`
36-
- Default: `pep440`
37-
38-
Select a version scheme from the following options:
39-
40-
- `pep440`
41-
- `semver`
42-
- `semver2`
43-
44-
Useful for non-python projects. [Read more][version-scheme]
45-
46-
### `tag_format`
47-
48-
- Type: `str`
49-
- Default: `$version`
50-
51-
Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [Read more][tag_format]
52-
53-
### `legacy_tag_formats`
54-
55-
- Type: `list`
56-
- Default: `[]`
57-
58-
Legacy git tag formats, useful for old projects that changed tag format.
59-
Tags matching those formats will be recognized as version tags and be included in the changelog.
60-
Each entry uses the syntax as [`tag_format`](#tag_format). [Read more][tag_format]
24+
Version provider used to read and write version. See [Version Provider](./version_provider.md) for more details.
6125

6226
### `ignored_tag_formats`
6327

@@ -243,7 +207,6 @@ Provide custom changelog jinja template path relative to the current working dir
243207
Provide extra variables to the changelog template. [Read more][template-customization]
244208

245209

246-
[version_files]: ../commands/bump.md#version_files
247210
[tag_format]: ../commands/bump.md#tag_format
248211
[bump_message]: ../commands/bump.md#bump_message
249212
[major-version-zero]: ../commands/bump.md#-major-version-zero

docs/tutorials/tag_format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ As a result, the tag generated on bump will have this format: `v1.0.0` and the v
4343
Both `$version` and `${version}` syntaxes are strictly equivalent. You can use the one you prefer.
4444

4545
See [the `version_scheme` section in `bump` command documentation](../commands/bump.md#version_scheme) for more details on version schemes and how to define your own.
46-
See [`tag_format`](../config/option.md#tag_format) and [`version_scheme`](../config/option.md#version_scheme) settings in [Configuration reference](../config/option.md) for more details on these settings.
46+
See [`tag_format`](../config/option.md#tag_format) and [`version_scheme`](../config/bump.md#version_scheme) settings in [Configuration reference](../config/option.md) for more details on these settings.
4747

4848
## Changing convention
4949

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ nav:
4545
- Configuration:
4646
- Configuration File: "config/configuration_file.md"
4747
- Version Provider: "config/version_provider.md"
48+
- Bump Options: "config/bump.md"
4849
- Settings: "config/option.md"
4950
- Customization: "customization.md"
5051
- Tutorials:

0 commit comments

Comments
 (0)