feat(commands/changelog): make changelog_file an option in config

Author: Lee-W

commitizen/cli.py

@@ -133,8 +133,7 @@
                     },
                     {
                         "name": "--file-name",
-                        "default": "CHANGELOG.md",
-                        "help": "file name of changelog",
+                        "help": "file name of changelog (default: 'CHANGELOG.md')",
                     },
                     {
                         "name": "--start-rev",

commitizen/commands/changelog.py

@@ -16,7 +16,7 @@ def __init__(self, config: BaseConfig, args):
         self.config: BaseConfig = config
         self.cz = factory.commiter_factory(self.config)
 
-        self.file_name = args["file_name"]
+        self.file_name = args["file_name"] or self.config.settings.get("changelog_file")
         self.dry_run = args["dry_run"]
         self.start_rev = args["start_rev"]
 

commitizen/defaults.py

@@ -13,6 +13,7 @@
     "version_files": [],
     "tag_format": None,  # example v$version
     "bump_message": None,  # bumped v$current_version to $new_version
+    "changelog_file": "CHANGELOG.md",
 }
 
 MAJOR = "MAJOR"

tests/test_conf.py

@@ -44,6 +44,7 @@
     "bump_message": None,
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],
     "style": [["pointer", "reverse"], ["question", "underline"]],
+    "changelog_file": "CHANGELOG.md",
 }
 
 _new_settings = {
@@ -53,13 +54,15 @@
     "bump_message": None,
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],
     "style": [["pointer", "reverse"], ["question", "underline"]],
+    "changelog_file": "CHANGELOG.md",
 }
 
 _read_settings = {
     "name": "cz_jira",
     "version": "1.0.0",
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],
     "style": [["pointer", "reverse"], ["question", "underline"]],
+    "changelog_file": "CHANGELOG.md",
 }