feat(config): Deprecate config.sections and config.section_mapping, replace with config.type_headers

README.md

@@ -31,11 +31,8 @@ changes from a `release_notes` folder.
 NOTE: `release_notes` support will be dropped in a future version, migration to
 conventional commits is recommended.
 
-By default supported sections are `feat`, `fix`, `docs` and `misc`. Additional types can be configured
-to map to these initial sections, custom sections can be added and mapped to types as well.
-
-See [Configuration](#Configuration) below for default sections and section
-mappings and how to customize them.
+See [Configuration](#Configuration) below for default commit type configuration
+and how to customize them.
 
 ```md
 ## <version>
@@ -185,13 +182,13 @@ issue_link = "http://github.com/EdgyEdgemond/changelog-gen/issues/::issue_ref::"
   **default**: None
 
   Create links in the CHANGELOG to the originating commit. A url that contains
-  an `$COMMIT_HASH` placeholder for replacement.
+  an `::commit_hash::` placeholder for replacement.
 
   Example:
 
 ```toml
 [toolchangelog_gen]
-commit_link = "http://github.com/EdgyEdgemond/changelog-gen/commit/$COMMIT_HASH"
+commit_link = "http://github.com/EdgyEdgemond/changelog-gen/commit/::commit_hash::"
 ```
 
 #### `version_string =`
@@ -246,17 +243,23 @@ allowed_branches = [
 ]
 ```
 
-#### `sections =`
+#### `type_headers = `
   _**[optional]**_<br />
   **default**: {
       "feat": "Features and Improvements",
       "fix": "Bug fixes",
       "docs": "Documentation",
-      "misc": "Miscellaneous",
+      "bug": "Bug fixes",
+      "chore": "Miscellaneous",
+      "ci": "Miscellaneous",
+      "perf": "Miscellaneous",
+      "refactor": "Miscellaneous",
+      "revert": "Miscellaneous",
+      "style": "Miscellaneous",
+      "test": "Miscellaneous",
   }
 
-  Define custom headers or new sections/headers, new sections will require a
-  matching section_mapping configuration.
+  Define commit types and which headers in the changelog they should map to.
 
   Example:
 
@@ -277,19 +280,45 @@ fix = "Bugfixes"
       "misc": "patch"
   }
 
-  Define custom section mappings for semver tagging. Any custom sections need
-  to be mapped to `major`, `minor`, `patch`. Any unknown sections will be
+  Define custom type mappings for semver tagging. Any custom types need
+  to be mapped to `major`, `minor`, `patch`. Any unknown types will be
   treated as a `patch`.
 
   Example:
 
 ```toml
-[tool.changelog_gen.sections]
+[tool.changelog_gen.semver_mapping]
 change = "patch"
 remove = "minor"
 ```
 
+#### `sections =`
+  _**[Deprecated]**_<br />
+  _**[optional]**_<br />
+  **default**: {
+      "feat": "Features and Improvements",
+      "fix": "Bug fixes",
+      "docs": "Documentation",
+      "misc": "Miscellaneous",
+  }
+
+  Define custom headers or new sections/headers, new sections will require a
+  matching section_mapping configuration.
+
+  This configuration has been deprecated, use `type_headers` instead.
+
+  Example:
+
+```toml
+[tool.changelog_gen.sections]
+feat = "New Features"
+change = "Changes"
+remove = "Removals"
+fix = "Bugfixes"
+```
+
 #### `section_mapping =`
+  _**[Deprecated]**_<br />
   _**[optional]**_<br />
   **default**: {
       "bug": "fix",
@@ -305,6 +334,8 @@ remove = "minor"
 
   Configure additional supported commit types to supported changelog sections.
 
+  This configuration has been deprecated, use `type_headers` instead.
+
   Example:
 
 ```toml

changelog_gen/cli/command.py

@@ -141,13 +141,11 @@ def _gen(cfg: config.Config, version_tag: str | None = None, *, dry_run: bool =
 
     process_info(Git.get_latest_tag_info(), cfg, dry_run=dry_run)
 
-    section_mapping = cfg.section_mapping
-    supported_sections = cfg.sections
+    e = extractor.ReleaseNoteExtractor(dry_run=dry_run, type_headers=cfg.type_headers)
+    sections = e.extract()
 
-    e = extractor.ReleaseNoteExtractor(dry_run=dry_run, supported_sections=supported_sections)
-    sections = e.extract(section_mapping)
-
-    if not e.unique_issues(sections) and cfg.reject_empty:
+    unique_issues = e.unique_issues(sections)
+    if not unique_issues and cfg.reject_empty:
         typer.echo("No changes present and reject_empty configured.")
         raise typer.Exit(code=0)
 
@@ -163,15 +161,15 @@ def _gen(cfg: config.Config, version_tag: str | None = None, *, dry_run: bool =
     w = writer.new_writer(extension, dry_run=dry_run, issue_link=cfg.issue_link, commit_link=cfg.commit_link)
 
     w.add_version(version_string)
-    w.consume(supported_sections, sections)
+    w.consume(cfg.type_headers, sections)
 
     typer.echo(w)
 
     processed = _finalise(w, e, version_tag, extension, cfg, dry_run=dry_run)
 
     post_process = cfg.post_process
     if post_process and processed:
-        unique_issues = [r for r in e.unique_issues(sections) if not r.startswith("__")]
+        unique_issues = [r for r in unique_issues if not r.startswith("__")]
         per_issue_post_process(post_process, sorted(unique_issues), version_tag, dry_run=dry_run)
 
 

changelog_gen/config.py

@@ -18,18 +18,40 @@
 
 logger = logging.getLogger(__name__)
 
-SUPPORTED_SECTIONS = {
+TYPE_HEADERS = {
     "feat": "Features and Improvements",
     "fix": "Bug fixes",
     "docs": "Documentation",
-    "misc": "Miscellaneous",
+    "bug": "Bug fixes",
+    "chore": "Miscellaneous",
+    "ci": "Miscellaneous",
+    "perf": "Miscellaneous",
+    "refactor": "Miscellaneous",
+    "revert": "Miscellaneous",
+    "style": "Miscellaneous",
+    "test": "Miscellaneous",
 }
 
 SEMVER_MAPPING = {
     "feat": "minor",
     "fix": "patch",
+    "bug": "patch",
+    "chore": "patch",
+    "ci": "patch",
     "docs": "patch",
-    "misc": "patch",
+    "perf": "patch",
+    "refactor": "patch",
+    "revert": "patch",
+    "style": "patch",
+    "test": "patch",
+}
+
+# Deprecated
+SUPPORTED_SECTIONS = {
+    "feat": "Features and Improvements",
+    "fix": "Bug fixes",
+    "docs": "Documentation",
+    "misc": "Miscellaneous",
 }
 
 DEFAULT_SECTION_MAPPING = {
@@ -134,9 +156,8 @@
     version_string: str = "v{new_version}"
 
     allowed_branches: list[str] = dataclasses.field(default_factory=list)
-    sections: dict = dataclasses.field(default_factory=lambda: SUPPORTED_SECTIONS)
+    type_headers: dict = dataclasses.field(default_factory=lambda: TYPE_HEADERS)
     semver_mapping: dict = dataclasses.field(default_factory=lambda: SEMVER_MAPPING)
-    section_mapping: dict = dataclasses.field(default_factory=lambda: DEFAULT_SECTION_MAPPING)
 
     release: bool = False
     commit: bool = False
@@ -174,9 +195,6 @@
         if "tool" not in data or "changelog_gen" not in data["tool"]:
             return cfg
 
-        if "post_process" in data["tool"]["changelog_gen"]:
-            pp = data["tool"]["changelog_gen"]["post_process"]
-            data["tool"]["changelog_gen"]["post_process"] = PostProcessConfig.from_dict(pp)
         return data["tool"]["changelog_gen"]
 
 
@@ -197,9 +215,11 @@
         ("date_format", extract_string_value),
         ("version_string", extract_string_value),
         ("allowed_branches", extract_list_value),
+        ("type_headers", extract_dict_value),
         ("sections", extract_dict_value),
         ("semver_mapping", extract_dict_value),
         ("section_mapping", extract_dict_value),
+        ("post_process", extract_dict_value),
         ("release", extract_boolean_value),
         ("commit", extract_boolean_value),
         ("allow_dirty", extract_boolean_value),
@@ -209,21 +229,53 @@
         if value:
             cfg[valuename] = value
 
-    for objectname, object_class in [
-        ("post_process", PostProcessConfig),
-    ]:
-        dictvalue = extract_dict_value(parser, objectname)
-        if dictvalue is None:
-            continue
-        try:
-            cfg[objectname] = object_class.from_dict(dictvalue)
-        except Exception as e:  # noqa: BLE001
-            msg = f"Failed to create {objectname}: {e!s}"
-            raise RuntimeError(msg) from e
-
     return cfg
 
 
+def check_deprecations(cfg: dict) -> None:
+    """Check parsed configuration dict for deprecated features."""
+    if cfg.get("post_process"):
+        url = cfg["post_process"].get("url", "")
+        body = cfg["post_process"].get("body", "")
+        if "{issue_ref}" in url or "{new_version}" in url:
+            warn(
+                "{replace} format strings are not supported in `post_process.url` configuration, use ::replace:: instead.",  # noqa: E501
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            cfg["post_process"]["url"] = url.format(issue_ref="::issue_ref::", new_version="::version::")
+        if "{issue_ref}" in body or "{new_version}" in body:
+            warn(
+                "{replace} format strings are not supported in `post_process.body` configuration, use ::replace:: instead.",  # noqa: E501
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            cfg["post_process"]["body"] = body.format(issue_ref="::issue_ref::", new_version="::version::")
+
+    if cfg.get("issue_link") and "{issue_ref}" in cfg["issue_link"]:
+        warn(
+            "{replace} format strings are not supported in `issue_link` configuration, use ::replace:: instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        cfg["issue_link"] = cfg["issue_link"].format(issue_ref="::issue_ref::", new_version="::version::")
+
+    if cfg.get("commit_link") and "{commit_hash}" in cfg["config_link"]:
+        warn(
+            "{replace} format strings are not supported in `config_link` configuration, use ::replace:: instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        cfg["commit_link"] = cfg["commit_link"].format(commit_hash="::commit_hash::")
+
+    if cfg.get("section_mapping") or cfg.get("sections"):
+        warn(
+            "`sections` and `section_mapping` are no longer supported, use `type_headers` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+
 def read(**kwargs) -> Config:  # noqa: C901, PLR0912
     """Read configuration from local environment.
 
@@ -245,39 +297,36 @@
         cfg = _process_setup_cfg(setup)
 
     if "post_process" not in cfg and post_process:
-        cfg["post_process"] = post_process
+        cfg["post_process"] = {
+            "url": post_process.url,
+            "auth_env": post_process.auth_env,
+        }
 
     if "post_process" in cfg and post_process:
-        cfg["post_process"].url = post_process.url or cfg["post_process"].url
-        cfg["post_process"].auth_env = post_process.auth_env or cfg["post_process"].auth_env
+        cfg["post_process"]["url"] = post_process.url or cfg["post_process"].get("url")
+        cfg["post_process"]["auth_env"] = post_process.auth_env or cfg["post_process"].get("auth_env")
 
     cfg.update(overrides)
 
+    check_deprecations(cfg)
+
     if cfg.get("post_process"):
-        url = cfg["post_process"].url
-        body = cfg["post_process"].body
-        if "{issue_ref}" in url or "{new_version}" in url:
-            warn(
-                "{replace} format strings are not supported in `post_process.url` configuration, use ::replace:: instead.",  # noqa: E501
-                DeprecationWarning,
-                stacklevel=2,
-            )
-            cfg["post_process"].url = url.format(issue_ref="::issue_ref::", new_version="::version::")
-        if "{issue_ref}" in body or "{new_version}" in body:
-            warn(
-                "{replace} format strings are not supported in `post_process.body` configuration, use ::replace:: instead.",  # noqa: E501
-                DeprecationWarning,
-                stacklevel=2,
-            )
-            cfg["post_process"].body = body.format(issue_ref="::issue_ref::", new_version="::version::")
+        pp = cfg["post_process"]
+        try:
+            cfg["post_process"] = PostProcessConfig.from_dict(pp)
+        except Exception as e:  # noqa: BLE001
+            msg = f"Failed to create post_process: {e!s}"
+            raise RuntimeError(msg) from e
 
-    if cfg.get("issue_link") and "{issue_ref}" in cfg["issue_link"]:
-        warn(
-            "{replace} format strings are not supported in `issue_link` configuration, use ::replace:: instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        cfg["issue_link"] = cfg["issue_link"].format(issue_ref="::issue_ref::", new_version="::version::")
+    if cfg.get("section_mapping") or cfg.get("sections") and not cfg.get("type_headers"):
+        sm = cfg.pop("section_mapping", DEFAULT_SECTION_MAPPING.copy())
+        s = cfg.pop("sections", SUPPORTED_SECTIONS.copy())
+
+        type_headers = s
+        for type_, section in sm.items():
+            type_headers[type_] = s.get(section, "Unknown")
+
+        cfg["type_headers"] = type_headers
 
     # this feels messy, but later on there is an update that should assist in cleaning this up.
     for key_path in [
@@ -306,12 +355,4 @@
                         msg = f"Replace string {replace}, not supported."
                         raise errors.UnsupportedReplaceError(msg)
 
-    if cfg.get("commit_link") and "{commit_hash}" in cfg["config_link"]:
-        warn(
-            "{replace} format strings are not supported in `config_link` configuration, use $REPLACE instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        cfg["commit_link"] = cfg["commit_link"].format(commit_hash="$COMMIT_HASH")
-
     return Config(**cfg)