docs(customization): adding information on commit_parser, changelog_pattern, change_type_map customizable fields

matteo_fiore · Lee-W · commit b0e98e103df1 · 2022-03-29T21:31:56.000+08:00
diff --git a/docs/customization.md b/docs/customization.md
@@ -26,6 +26,9 @@ info_path = "cz_customize_info.txt"
 info = """
 This is customized info
 """
+commit_parser = "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?"
+changelog_pattern = "^(feature|bug fix)?(!)?"
+change_type_map = {"feature" = "Feat", "bug fix" = "Fix"}
 
 [[tool.commitizen.customize.questions]]
 type = "list"
@@ -66,6 +69,9 @@ The equivalent example for a json config file:
             "change_type_order": ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"],
             "info_path": "cz_customize_info.txt",
             "info": "This is customized info",
+            "commit_parser": "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?",
+            "changelog_pattern": "^(feature|bug fix)?(!)?",
+            "change_type_map": {"feature": "Feat", "bug fix": "Fix"},
             "questions": [
                 {
                     "type": "list",
@@ -109,6 +115,11 @@ commitizen:
     schema: "<type>: <body>"
     schema_pattern: "(feature|bug fix):(\\s.*)"
     bump_pattern: "^(break|new|fix|hotfix)"
+    commit_parser: "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?",
+    changelog_pattern: "^(feature|bug fix)?(!)?",
+    change_type_map:
+      feature: Feat
+      bug fix: Fix
     bump_map:
       break: MAJOR
       new: MINOR
@@ -148,8 +159,12 @@ commitizen:
 | `bump_map`          | `dict` | `None`  | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`)                                                                                                                 |
 | `bump_pattern`      | `str`  | `None`  | (OPTIONAL) Regex to extract information from commit (subject and body)                                                                                                                                                           |
 | `change_type_order` | `str`  | `None`  | (OPTIONAL) List of strings used to order the Changelog. All other types will be sorted alphabetically. Default is `["BREAKING CHANGE", "feat", "fix", "refactor", "perf"]`                                                       |
+| `commit_parser`     | `str`  | `None`  | (OPTIONAL) Regex to extract information used in creating changelog. [See more][changelog-spec]                                                                                                                                   |
+| `changelog_pattern` | `str`  | `None`  | (OPTIONAL) Regex to understand which commits to include in the changelog                                                                                                                                                         |
+| `change_type_map`   | `dict` | `None`  | (OPTIONAL) Dictionary mapping the type of the commit to a changelog entry                                                                                                                                                        |
 
 [jinja2]: https://jinja.palletsprojects.com/en/2.10.x/
+[changelog-spec]: https://commitizen-tools.github.io/commitizen/changelog/
 
 #### Detailed `questions` content
 
