Merge branch 'master' into fix/bump-changelog-merge-pre-removes-header

Author: edgarrmondragon

.pre-commit-config.yaml

@@ -56,7 +56,7 @@ repos:
           - tomli
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v4.13.4 # automatically updated by Commitizen
+    rev: v4.13.5 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v4.13.5 (2026-02-05)
+
+### Fix
+
+- **changelog**: add incremental parameter to changelog generation (#1808)
+
 ## v4.13.4 (2026-02-04)
 
 ### Fix

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "4.13.4"
+__version__ = "4.13.5"

commitizen/commands/changelog.py

@@ -284,6 +284,7 @@ def __call__(self) -> None:
             self.cz.template_loader,
             self.template,
             **{
+                "incremental": self.incremental,  # extra variable for the template
                 **self.cz.template_extras,
                 **self.config.settings["extras"],
                 **self.extras,

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "commitizen"
-version = "4.13.4"
+version = "4.13.5"
 description = "Python commitizen client tool"
 authors = [{ name = "Santiago Fraire", email = "santiwilly@gmail.com" }]
 maintainers = [
@@ -235,15 +235,7 @@ select = [
     "TC005",
     "TC006",
 ]
-ignore = [
-    "E501",
-    "D1",
-    "D415",
-    "PT006", # TODO(bearomorphism): enable this rule
-    "PT007", # TODO(bearomorphism): enable this rule
-    "PT011", # TODO(bearomorphism): enable this rule
-    "PT022", # TODO(bearomorphism): enable this rule
-]
+ignore = ["E501", "D1", "D415"]
 extend-safe-fixes = [
     "TC", # Move imports inside/outside TYPE_CHECKING blocks
     "UP", # Update syntaxes for current Python version recommendations

tests/commands/test_bump_command.py

@@ -40,14 +40,14 @@
 
 @pytest.mark.parametrize(
     "commit_msg",
-    (
+    [
         "fix: username exception",
         "fix(user): username exception",
         "refactor: remove ini configuration support",
         "refactor(config): remove ini configuration support",
         "perf: update to use multiprocess",
         "perf(worker): update to use multiprocess",
-    ),
+    ],
 )
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_patch_increment(commit_msg: str, util: UtilFixture):
@@ -56,7 +56,7 @@ def test_bump_patch_increment(commit_msg: str, util: UtilFixture):
     assert git.tag_exist("0.1.1") is True
 
 
-@pytest.mark.parametrize("commit_msg", ("feat: new file", "feat(user): new file"))
+@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"])
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_minor_increment(commit_msg: str, util: UtilFixture):
     util.create_file_and_commit(commit_msg)
@@ -68,7 +68,7 @@ def test_bump_minor_increment(commit_msg: str, util: UtilFixture):
     )
 
 
-@pytest.mark.parametrize("commit_msg", ("feat: new file", "feat(user): new file"))
+@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"])
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_minor_increment_annotated(commit_msg: str, util: UtilFixture):
     util.create_file_and_commit(commit_msg)
@@ -82,7 +82,7 @@ def test_bump_minor_increment_annotated(commit_msg: str, util: UtilFixture):
     assert git.is_signed_tag("0.2.0") is False
 
 
-@pytest.mark.parametrize("commit_msg", ("feat: new file", "feat(user): new file"))
+@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"])
 @pytest.mark.usefixtures("tmp_commitizen_project_with_gpg")
 def test_bump_minor_increment_signed(commit_msg: str, util: UtilFixture):
     util.create_file_and_commit(commit_msg)
@@ -96,7 +96,7 @@ def test_bump_minor_increment_signed(commit_msg: str, util: UtilFixture):
     assert git.is_signed_tag("0.2.0") is True
 
 
-@pytest.mark.parametrize("commit_msg", ("feat: new file", "feat(user): new file"))
+@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"])
 def test_bump_minor_increment_annotated_config_file(
     commit_msg: str, util: UtilFixture, pyproject: Path
 ):
@@ -112,7 +112,7 @@ def test_bump_minor_increment_annotated_config_file(
     assert git.is_signed_tag("0.2.0") is False
 
 
-@pytest.mark.parametrize("commit_msg", ("feat: new file", "feat(user): new file"))
+@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"])
 def test_bump_minor_increment_signed_config_file(
     commit_msg: str, util: UtilFixture, tmp_commitizen_project_with_gpg
 ):
@@ -132,7 +132,7 @@ def test_bump_minor_increment_signed_config_file(
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.parametrize(
     "commit_msg",
-    (
+    [
         "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported",
         "feat!: new user interface\n\nBREAKING CHANGE: age is no longer supported",
         "feat!: new user interface",
@@ -141,7 +141,7 @@ def test_bump_minor_increment_signed_config_file(
         "feat(user)!: new user interface",
         "BREAKING CHANGE: age is no longer supported",
         "BREAKING-CHANGE: age is no longer supported",
-    ),
+    ],
 )
 def test_bump_major_increment(commit_msg: str, util: UtilFixture):
     util.create_file_and_commit(commit_msg)
@@ -152,7 +152,7 @@ def test_bump_major_increment(commit_msg: str, util: UtilFixture):
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.parametrize(
     "commit_msg",
-    (
+    [
         "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported",
         "feat!: new user interface\n\nBREAKING CHANGE: age is no longer supported",
         "feat!: new user interface",
@@ -161,7 +161,7 @@ def test_bump_major_increment(commit_msg: str, util: UtilFixture):
         "feat(user)!: new user interface",
         "BREAKING CHANGE: age is no longer supported",
         "BREAKING-CHANGE: age is no longer supported",
-    ),
+    ],
 )
 def test_bump_major_increment_major_version_zero(commit_msg: str, util: UtilFixture):
     util.create_file_and_commit(commit_msg)
@@ -171,7 +171,7 @@ def test_bump_major_increment_major_version_zero(commit_msg: str, util: UtilFixt
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.parametrize(
-    "commit_msg,increment,expected_tag",
+    ("commit_msg", "increment", "expected_tag"),
     [
         ("feat: new file", "PATCH", "0.1.1"),
         ("fix: username exception", "major", "1.0.0"),
@@ -607,7 +607,7 @@ def test_bump_with_git_to_stdout_arg(util: UtilFixture, capsys: pytest.CaptureFi
 
 
 @pytest.mark.parametrize(
-    "version_filepath, version_regex, version_file_content",
+    ("version_filepath", "version_regex", "version_file_content"),
     [
         pytest.param(
             "pyproject.toml",
@@ -779,7 +779,7 @@ def test_bump_manual_version_disallows_major_version_zero(util: UtilFixture):
 
 
 @pytest.mark.parametrize(
-    "initial_version, expected_version_after_bump",
+    ("initial_version", "expected_version_after_bump"),
     [
         ("1", "1.1.0"),
         ("1.2", "1.3.0"),
@@ -804,7 +804,7 @@ def test_bump_version_with_less_components_in_config(
             assert expected_version_after_bump in f.read()
 
 
-@pytest.mark.parametrize("commit_msg", ("feat: new file", "feat(user): new file"))
+@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"])
 def test_bump_with_pre_bump_hooks(
     commit_msg, mocker: MockFixture, tmp_commitizen_project, util: UtilFixture
 ):
@@ -992,7 +992,7 @@ def test_bump_command_prerelease_scheme_check_old_tags(
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.usefixtures("use_cz_semver")
 @pytest.mark.parametrize(
-    "message, expected_tag",
+    ("message", "expected_tag"),
     [
         ("minor: add users", "0.2.0"),
         ("patch: bug affecting users", "0.1.1"),
@@ -1008,7 +1008,7 @@ def test_bump_with_plugin(util: UtilFixture, message: str, expected_tag: str):
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.usefixtures("use_cz_semver")
 @pytest.mark.parametrize(
-    "message, expected_tag",
+    ("message", "expected_tag"),
     [
         ("minor: add users", "0.2.0"),
         ("patch: bug affecting users", "0.1.1"),
@@ -1060,14 +1060,14 @@ def test_bump_command_version_scheme_priority_over_version_type(util: UtilFixtur
 
 
 @pytest.mark.parametrize(
-    "arg, cfg, expected",
-    (
+    ("arg", "cfg", "expected"),
+    [
         pytest.param("", "", "default", id="default"),
         pytest.param("", "changelog.cfg", "from config", id="from-config"),
         pytest.param(
             "--template=changelog.cmd", "changelog.cfg", "from cmd", id="from-command"
         ),
-    ),
+    ],
 )
 def test_bump_template_option_precedence(
     tmp_commitizen_project: Path,

tests/commands/test_changelog_command.py

@@ -692,7 +692,7 @@ def test_changelog_incremental_with_release_candidate_version(
 
 
 @pytest.mark.parametrize(
-    "from_pre,to_pre", itertools.product(["alpha", "beta", "rc"], repeat=2)
+    ("from_pre", "to_pre"), itertools.product(["alpha", "beta", "rc"], repeat=2)
 )
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.freeze_time("2021-06-11")
@@ -856,13 +856,13 @@ def test_changelog_from_rev_latest_version_from_arg(
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.parametrize(
-    "rev_range,tag",
-    (
+    ("rev_range", "tag"),
+    [
         pytest.param("0.8.0", "0.2.0", id="single-not-found"),
         pytest.param("0.1.0..0.3.0", "0.3.0", id="lower-bound-not-found"),
         pytest.param("0.1.0..0.3.0", "0.1.0", id="upper-bound-not-found"),
         pytest.param("0.3.0..0.4.0", "0.2.0", id="none-found"),
-    ),
+    ],
 )
 def test_changelog_from_rev_range_not_found(
     config_path: Path, rev_range: str, tag: str, util: UtilFixture
@@ -1270,14 +1270,14 @@ def test_changelog_from_current_version_tag_with_nonversion_tag(
 
 
 @pytest.mark.parametrize(
-    "arg,cfg,expected",
-    (
+    ("arg", "cfg", "expected"),
+    [
         pytest.param("", "", "default", id="default"),
         pytest.param("", "changelog.cfg", "from config", id="from-config"),
         pytest.param(
             "--template=changelog.cmd", "changelog.cfg", "from cmd", id="from-command"
         ),
-    ),
+    ],
 )
 def test_changelog_template_option_precedence(
     tmp_commitizen_project: Path,
@@ -1588,12 +1588,12 @@ def test_changelog_template_extra_quotes(
 
 
 @pytest.mark.parametrize(
-    "extra, expected",
-    (
+    ("extra", "expected"),
+    [
         pytest.param("key=value=", "value=", id="2-equals"),
         pytest.param("key==value", "=value", id="2-consecutive-equals"),
         pytest.param("key==value==", "=value==", id="multiple-equals"),
-    ),
+    ],
 )
 def test_changelog_template_extra_weird_but_valid(
     changelog_tpl: Path,
@@ -1609,7 +1609,7 @@ def test_changelog_template_extra_weird_but_valid(
     assert changelog_file.read_text() == expected
 
 
-@pytest.mark.parametrize("extra", ("no-equal", "", "=no-key"))
+@pytest.mark.parametrize("extra", ["no-equal", "", "=no-key"])
 def test_changelog_template_extra_bad_format(
     changelog_tpl: Path,
     extra: str,
@@ -1672,3 +1672,57 @@ class FakeTemplate:
 
     assert not changelog_jinja_file.exists()
     assert "Template filename is not set" in str(exc_info.value)
+
+
+def test_changelog_template_incremental_variable(
+    tmp_commitizen_project: Path,
+    any_changelog_format: ChangelogFormat,
+    util: UtilFixture,
+    file_regression: FileRegressionFixture,
+):
+    """
+    Test that the changelog template is not rendered when the incremental flag is not set.
+    Reference: https://github.com/commitizen-tools/commitizen/discussions/1620
+    """
+    project_root = Path(tmp_commitizen_project)
+    changelog_tpl = project_root / any_changelog_format.template
+    changelog_tpl.write_text(
+        dedent("""
+        {% if not incremental %}
+        # CHANGELOG
+        {% endif %}
+
+        {% for entry in tree %}
+
+        ## {{ entry.version }}{% if entry.date %} ({{ entry.date }}){% endif %}
+
+        {% for change_key, changes in entry.changes.items() %}
+
+        {% if change_key %}
+        ### {{ change_key }}
+        {% endif %}
+
+        {% for change in changes %}
+        {% if change.scope %}
+        - **{{ change.scope }}**: {{ change.message }}
+        {% elif change.message %}
+        - {{ change.message }}
+        {% endif %}
+        {% endfor %}
+        {% endfor %}
+        {% endfor %}
+        """)
+    )
+    target = "CHANGELOG.md"
+
+    util.create_file_and_commit("feat(foo): new file")
+    util.run_cli("changelog", "--file-name", target)
+    with open(target, encoding="utf-8") as f:
+        out = f.read()
+    file_regression.check(out, extension=".md")
+
+    util.create_file_and_commit("refactor(bar): another new file")
+    util.run_cli("changelog", "--file-name", target, "--incremental")
+    with open(target, encoding="utf-8") as f:
+        out = f.read()
+    file_regression.check(out, extension=".incremental.md")

tests/commands/test_changelog_command/test_changelog_template_incremental_variable.incremental.md

@@ -0,0 +1,12 @@
+# CHANGELOG
+
+
+## Unreleased
+
+### Feat
+
+- **foo**: new file
+
+### Refactor
+
+- **bar**: another new file

tests/commands/test_changelog_command/test_changelog_template_incremental_variable.md

@@ -0,0 +1,8 @@
+# CHANGELOG
+
+
+## Unreleased
+
+### Feat
+
+- **foo**: new file