Skip to content

Commit b2e9c1b

Browse files
edgarrmondragonLee-W
authored andcommitted
docs(config.md): Document glob pattern support in version_files
It was added in #1070 but never documented AFAICT.
1 parent d0c89af commit b2e9c1b

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/commands/bump.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ Supported variables:
472472

473473
### `version_files` \*
474474

475-
It is used to identify the files which should be updated with the new version.
475+
It is used to identify the files or glob patterns which should be updated with the new version.
476476
It is also possible to provide a pattern for each file, separated by colons (`:`).
477477

478478
Commitizen will update its configuration file automatically (`pyproject.toml`, `.cz`) when bumping,
@@ -488,7 +488,8 @@ Some examples
488488
[tool.commitizen]
489489
version_files = [
490490
"src/__version__.py",
491-
"setup.py:version"
491+
"packages/*/pyproject.toml:version",
492+
"setup.py:version",
492493
]
493494
```
494495

docs/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Type: `list`
2424

2525
Default: `[ ]`
2626

27-
Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [Read more][version_files]
27+
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]
2828

2929
### `version_provider`
3030

0 commit comments

Comments
 (0)