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

Lee-W · Lee-W · commit 2becf57dbe2e · 2020-04-20T23:06:38.000+08:00
diff --git a/commitizen/cli.py b/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",
diff --git a/commitizen/commands/changelog.py b/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"]
 
diff --git a/commitizen/defaults.py b/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"
diff --git a/tests/test_conf.py b/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",
 }
 
 

Original file line number	Diff line number	Diff line change
`@@ -133,8 +133,7 @@`
`133`	`133`	`},`
`134`	`134`	`{`
`135`	`135`	`"name": "--file-name",`
`136`		`- "default": "CHANGELOG.md",`
`137`		`- "help": "file name of changelog",`
	`136`	`+ "help": "file name of changelog (default: 'CHANGELOG.md')",`
`138`	`137`	`},`
`139`	`138`	`{`
`140`	`139`	`"name": "--start-rev",`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`"version_files": [],`
`14`	`14`	`"tag_format": None, # example v$version`
`15`	`15`	`"bump_message": None, # bumped v$current_version to $new_version`
	`16`	`+ "changelog_file": "CHANGELOG.md",`
`16`	`17`	`}`
`17`	`18`
`18`	`19`	`MAJOR = "MAJOR"`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@`
`44`	`44`	`"bump_message": None,`
`45`	`45`	`"version_files": ["commitizen/__version__.py", "pyproject.toml"],`
`46`	`46`	`"style": [["pointer", "reverse"], ["question", "underline"]],`
	`47`	`+ "changelog_file": "CHANGELOG.md",`
`47`	`48`	`}`
`48`	`49`
`49`	`50`	`_new_settings = {`
`@@ -53,13 +54,15 @@`
`53`	`54`	`"bump_message": None,`
`54`	`55`	`"version_files": ["commitizen/__version__.py", "pyproject.toml"],`
`55`	`56`	`"style": [["pointer", "reverse"], ["question", "underline"]],`
	`57`	`+ "changelog_file": "CHANGELOG.md",`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`_read_settings = {`
`59`	`61`	`"name": "cz_jira",`
`60`	`62`	`"version": "1.0.0",`
`61`	`63`	`"version_files": ["commitizen/__version__.py", "pyproject.toml"],`
`62`	`64`	`"style": [["pointer", "reverse"], ["question", "underline"]],`
	`65`	`+ "changelog_file": "CHANGELOG.md",`
`63`	`66`	`}`
`64`	`67`
`65`	`68`