From 222cff5db6df204257038c12bec4a5b663ed3a31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez=20Mondrag=C3=B3n?= Date: Fri, 11 Jul 2025 20:54:37 -0600 Subject: [PATCH] docs(config.md): Document glob pattern support in `version_files` It was added in https://github.com/commitizen-tools/commitizen/pull/1070 but never documented AFAICT. --- docs/commands/bump.md | 5 +++-- docs/config.md | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/commands/bump.md b/docs/commands/bump.md index 1320e30a7a..548f6e3616 100644 --- a/docs/commands/bump.md +++ b/docs/commands/bump.md @@ -472,7 +472,7 @@ Supported variables: ### `version_files` \* -It is used to identify the files which should be updated with the new version. +It is used to identify the files or glob patterns which should be updated with the new version. It is also possible to provide a pattern for each file, separated by colons (`:`). Commitizen will update its configuration file automatically (`pyproject.toml`, `.cz`) when bumping, @@ -488,7 +488,8 @@ Some examples [tool.commitizen] version_files = [ "src/__version__.py", - "setup.py:version" + "packages/*/pyproject.toml:version", + "setup.py:version", ] ``` diff --git a/docs/config.md b/docs/config.md index 5ca2c5d788..649881daec 100644 --- a/docs/config.md +++ b/docs/config.md @@ -24,7 +24,7 @@ Type: `list` Default: `[ ]` -Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [Read more][version_files] +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] ### `version_provider`