You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The changes made update the wording in the documentation to clarify the roles of `include_bumps` and `exclude_bumps` in the bump-my-version configuration. Additionally, unnecessary repetition was removed and overlapping examples were also corrected.
Copy file name to clipboardexpand all lines: docs/reference/configuration.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -736,9 +736,9 @@ if `True`, don't fail if the configured file is missing.
736
736
type
737
737
: list of strings
738
738
739
-
The `include_bumps` file configuration allows you to control when this file is changed by inclusion. Its alternative is the `exclude_bumps` configuration. When a `bump <version component>` command is issued, this file is changed only if the version component is in this list and not in [`exclude_bumps`](#exclude_bumps). The [parse](#parse) configuration defines version components.
739
+
The `include_bumps` file configuration allows you to control when bump-my-version includes this file for changes. Its alternative is the `exclude_bumps` configuration. When a `bump <version component>` command is issued, this file is changed only if the version component is in this list and not in [`exclude_bumps`](#exclude_bumps). The [parse](#parse) configuration defines version components.
740
740
741
-
The default value, or an empty list, includes all version components.
741
+
The default value, or an empty list, includes all version components.
742
742
743
743
### exclude_bumps
744
744
@@ -753,17 +753,17 @@ The default value, or an empty list, includes all version components.
753
753
type
754
754
: list of strings
755
755
756
-
The `exclude_bumps` file configuration allows you to control when this file is changed by exclusion. Its alternative is the `include_bumps` configuration.When a `bump <version component>` command is issued, this file is only changed if the version component is *not in this list.* The [parse](#parse) configuration defines version components.
756
+
The `exclude_bumps` file configuration allows you to control when bump-my-version excludes this file for changes. Its alternative is the `include_bumps` configuration.When a `bump <version component>` command is issued, this file is only changed if the version component is *not in this list.* The [parse](#parse) configuration defines version components.
757
757
758
758
The default value does not exclude anything.
759
759
760
760
### Examples
761
761
762
762
=== "TOML"
763
763
764
-
TOML allows us to specify the files using an [array of tables.](https://toml.io/en/v1.0.0#array-of-tables) TOML configuration files add two configuration fields to each file configuration: `filename` and `glob`. These fields are mutually exclusive: if you specify a value for both, only the `glob` value is used.
764
+
TOML allows us to specify the files using an [array of tables.](https://toml.io/en/v1.0.0#array-of-tables) TOML configuration adds two fields to each file configuration: `filename` and `glob`. These fields are mutually exclusive: if you specify a value for both, only the `glob` value is used.
765
765
766
-
For example, to change `coolapp/__init__.py` with the defaults, and alter `CHANGELOG.md` in twice:
766
+
For example, to change `coolapp/__init__.py` with the defaults and alter `CHANGELOG.md` twice:
767
767
768
768
```toml
769
769
[[tool.bumpversion.files]]
@@ -790,9 +790,9 @@ The default value does not exclude anything.
790
790
The configuration file format requires each section header to be unique. If you want to process a certain file multiple times, you may append a description between parens to the `file` keyword: `[bumpversion:file (special one):…]`.
791
791
792
792
793
-
794
-
For example, to change `coolapp/__init__.py` with the defaults, and alter `CHANGELOG.md` in twice:
795
-
793
+
794
+
For example, to change `coolapp/__init__.py` with the defaults and alter `CHANGELOG.md` twice:
0 commit comments