Skip to content

Commit b15598c

Browse files
bearomorphismCopilot
bearomorphism
and
Copilot
committed
test(changelog): regenerate help snapshots for --no-incremental flag
Update the CLI help golden files (all supported Python versions) and docs/commands/changelog.md to reflect the new --no-incremental option added in a previous commit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 194923d commit b15598c

6 files changed

Lines changed: 50 additions & 15 deletions

‎docs/commands/changelog.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,16 @@ This flag can be set in the configuration file with the key `changelog_increment
115115
changelog_incremental = true
116116
```
117117

118+
Pass `--no-incremental` on the command line to disable incremental generation
119+
for a single run, even when `changelog_incremental = true` is set in the
120+
configuration. This is useful, for example, when generating a one-off
121+
changelog for a specific `rev_range`, since `--incremental` cannot be combined
122+
with a `rev_range`.
123+
124+
```bash
125+
cz changelog --no-incremental "v1.0.0..v1.1.0"
126+
```
127+
118128
### `--start-rev`
119129

120130
Start from a given git rev to generate the changelog. Commits before that rev will not be considered. This is especially useful for long-running projects adopting conventional commits, where old commit messages might fail to be parsed for changelog generation.

‎tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_changelog_.txt‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME]
2-
[--unreleased-version UNRELEASED_VERSION] [--incremental]
3-
[--start-rev START_REV] [--merge-prerelease]
2+
[--unreleased-version UNRELEASED_VERSION]
3+
[--incremental | --no-incremental] [--start-rev START_REV]
4+
[--merge-prerelease]
45
[--version-scheme {pep440,semver,semver2}]
56
[--export-template EXPORT_TEMPLATE] [--template TEMPLATE]
67
[--extra EXTRA] [--tag-format TAG_FORMAT]
@@ -20,8 +21,12 @@ options:
2021
--unreleased-version UNRELEASED_VERSION
2122
Set the value for the new version (use the tag value),
2223
instead of using unreleased versions.
23-
--incremental Generate changelog from the last created version,
24+
--incremental, --no-incremental
25+
Generate changelog from the last created version,
2426
useful if the changelog has been manually modified.
27+
Use `--no-incremental` to override a
28+
`changelog_incremental` setting enabled in the
29+
configuration.
2530
--start-rev START_REV
2631
Start rev of the changelog. If not set, it will
2732
generate changelog from the beginning.

‎tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_changelog_.txt‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME]
2-
[--unreleased-version UNRELEASED_VERSION] [--incremental]
3-
[--start-rev START_REV] [--merge-prerelease]
2+
[--unreleased-version UNRELEASED_VERSION]
3+
[--incremental | --no-incremental] [--start-rev START_REV]
4+
[--merge-prerelease]
45
[--version-scheme {pep440,semver,semver2}]
56
[--export-template EXPORT_TEMPLATE] [--template TEMPLATE]
67
[--extra EXTRA] [--tag-format TAG_FORMAT]
@@ -20,8 +21,12 @@ options:
2021
--unreleased-version UNRELEASED_VERSION
2122
Set the value for the new version (use the tag value),
2223
instead of using unreleased versions.
23-
--incremental Generate changelog from the last created version,
24+
--incremental, --no-incremental
25+
Generate changelog from the last created version,
2426
useful if the changelog has been manually modified.
27+
Use `--no-incremental` to override a
28+
`changelog_incremental` setting enabled in the
29+
configuration.
2530
--start-rev START_REV
2631
Start rev of the changelog. If not set, it will
2732
generate changelog from the beginning.

‎tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_changelog_.txt‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME]
2-
[--unreleased-version UNRELEASED_VERSION] [--incremental]
3-
[--start-rev START_REV] [--merge-prerelease]
2+
[--unreleased-version UNRELEASED_VERSION]
3+
[--incremental | --no-incremental] [--start-rev START_REV]
4+
[--merge-prerelease]
45
[--version-scheme {pep440,semver,semver2}]
56
[--export-template EXPORT_TEMPLATE] [--template TEMPLATE]
67
[--extra EXTRA] [--tag-format TAG_FORMAT]
@@ -20,8 +21,12 @@ options:
2021
--unreleased-version UNRELEASED_VERSION
2122
Set the value for the new version (use the tag value),
2223
instead of using unreleased versions.
23-
--incremental Generate changelog from the last created version,
24+
--incremental, --no-incremental
25+
Generate changelog from the last created version,
2426
useful if the changelog has been manually modified.
27+
Use `--no-incremental` to override a
28+
`changelog_incremental` setting enabled in the
29+
configuration.
2530
--start-rev START_REV
2631
Start rev of the changelog. If not set, it will
2732
generate changelog from the beginning.

‎tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_changelog_.txt‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME]
2-
[--unreleased-version UNRELEASED_VERSION] [--incremental]
3-
[--start-rev START_REV] [--merge-prerelease]
2+
[--unreleased-version UNRELEASED_VERSION]
3+
[--incremental | --no-incremental] [--start-rev START_REV]
4+
[--merge-prerelease]
45
[--version-scheme {pep440,semver,semver2}]
56
[--export-template EXPORT_TEMPLATE] [--template TEMPLATE]
67
[--extra EXTRA] [--tag-format TAG_FORMAT]
@@ -20,8 +21,12 @@ options:
2021
--unreleased-version UNRELEASED_VERSION
2122
Set the value for the new version (use the tag value),
2223
instead of using unreleased versions.
23-
--incremental Generate changelog from the last created version,
24+
--incremental, --no-incremental
25+
Generate changelog from the last created version,
2426
useful if the changelog has been manually modified.
27+
Use `--no-incremental` to override a
28+
`changelog_incremental` setting enabled in the
29+
configuration.
2530
--start-rev START_REV
2631
Start rev of the changelog. If not set, it will
2732
generate changelog from the beginning.

‎tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_changelog_.txt‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME]
2-
[--unreleased-version UNRELEASED_VERSION] [--incremental]
3-
[--start-rev START_REV] [--merge-prerelease]
2+
[--unreleased-version UNRELEASED_VERSION]
3+
[--incremental | --no-incremental] [--start-rev START_REV]
4+
[--merge-prerelease]
45
[--version-scheme {pep440,semver,semver2}]
56
[--export-template EXPORT_TEMPLATE] [--template TEMPLATE]
67
[--extra EXTRA] [--tag-format TAG_FORMAT]
@@ -20,8 +21,12 @@ options:
2021
--unreleased-version UNRELEASED_VERSION
2122
Set the value for the new version (use the tag value),
2223
instead of using unreleased versions.
23-
--incremental Generate changelog from the last created version,
24+
--incremental, --no-incremental
25+
Generate changelog from the last created version,
2426
useful if the changelog has been manually modified.
27+
Use `--no-incremental` to override a
28+
`changelog_incremental` setting enabled in the
29+
configuration.
2530
--start-rev START_REV
2631
Start rev of the changelog. If not set, it will
2732
generate changelog from the beginning.

0 commit comments

Comments
 (0)