fix(parser-angular): change Fixes commit type heading to Bug Fixes (

#1064) * test(fixtures): update expected changelog heading to `Bug Fixes` * test(unit): update expected changelog heading to `Bug Fixes`
python-semantic-release · Oct 18, 2024 · 09e3a4d · 09e3a4d
1 parent 9dca116
commit 09e3a4d
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 20 deletions.
diff --git a/semantic_release/commit_parser/angular.py b/semantic_release/commit_parser/angular.py
@@ -35,7 +35,7 @@ def _logged_parse_error(commit: Commit, error: str) -> ParseError:
     "chore": "chores",
     "docs": "documentation",
     "feat": "features",
-    "fix": "fixes",
+    "fix": "bug fixes",
     "perf": "performance improvements",
     "refactor": "refactoring",
     "style": "code style",

diff --git a/tests/fixtures/repos/git_flow/repo_w_2_release_channels.py b/tests/fixtures/repos/git_flow/repo_w_2_release_channels.py
@@ -55,7 +55,7 @@ def get_commits_for_git_flow_repo_with_2_release_channels() -> GetRepoDefinition
         },
         "0.1.1-rc.1": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],
@@ -152,7 +152,7 @@ def get_commits_for_git_flow_repo_with_2_release_channels() -> GetRepoDefinition
         },
         "1.1.1": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],
@@ -209,8 +209,8 @@ def get_commits_for_git_flow_repo_with_2_release_channels() -> GetRepoDefinition
                 # But value is ultimately defined by the commits, which means the commits are
                 # referenced by index value
                 "angular": [
+                    {"section": "Bug Fixes", "i_commits": [1]},
                     {"section": "Features", "i_commits": [0]},
-                    {"section": "Fixes", "i_commits": [1]},
                 ],
                 "emoji": [
                     {"section": ":bug:", "i_commits": [1]},

diff --git a/tests/fixtures/repos/git_flow/repo_w_3_release_channels.py b/tests/fixtures/repos/git_flow/repo_w_3_release_channels.py
@@ -55,7 +55,7 @@ def get_commits_for_git_flow_repo_w_3_release_channels() -> GetRepoDefinitionFn:
         },
         "0.1.1-rc.1": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],
@@ -152,7 +152,7 @@ def get_commits_for_git_flow_repo_w_3_release_channels() -> GetRepoDefinitionFn:
         },
         "1.1.0-rc.2": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],
@@ -230,7 +230,7 @@ def get_commits_for_git_flow_repo_w_3_release_channels() -> GetRepoDefinitionFn:
         },
         "1.1.0-alpha.3": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],

diff --git a/tests/fixtures/repos/github_flow/repo_w_release_channels.py b/tests/fixtures/repos/github_flow/repo_w_release_channels.py
@@ -55,7 +55,7 @@ def get_commits_for_github_flow_repo_w_feature_release_channel() -> GetRepoDefin
         },
         "0.1.1-rc.1": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],

diff --git a/tests/fixtures/repos/trunk_based_dev/repo_w_no_tags.py b/tests/fixtures/repos/trunk_based_dev/repo_w_no_tags.py
@@ -42,8 +42,8 @@ def get_commits_for_trunk_only_repo_w_no_tags() -> GetRepoDefinitionFn:
                 # But value is ultimately defined by the commits, which means the commits are
                 # referenced by index value
                 "angular": [
+                    {"section": "Bug Fixes", "i_commits": [3, 1]},
                     {"section": "Features", "i_commits": [2]},
-                    {"section": "Fixes", "i_commits": [3, 1]},
                     {"section": "Unknown", "i_commits": [0]},
                 ],
                 "emoji": [

diff --git a/tests/fixtures/repos/trunk_based_dev/repo_w_prereleases.py b/tests/fixtures/repos/trunk_based_dev/repo_w_prereleases.py
@@ -55,7 +55,7 @@ def get_commits_for_trunk_only_repo_w_prerelease_tags() -> GetRepoDefinitionFn:
         },
         "0.1.1-rc.1": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],

diff --git a/tests/fixtures/repos/trunk_based_dev/repo_w_tags.py b/tests/fixtures/repos/trunk_based_dev/repo_w_tags.py
@@ -55,7 +55,7 @@ def get_commits_for_trunk_only_repo_w_tags() -> GetRepoDefinitionFn:
         },
         "0.1.1": {
             "changelog_sections": {
-                "angular": [{"section": "Fixes", "i_commits": [0]}],
+                "angular": [{"section": "Bug Fixes", "i_commits": [0]}],
                 "emoji": [{"section": ":bug:", "i_commits": [0]}],
                 "scipy": [{"section": "Fix", "i_commits": [0]}],
                 "tag": [{"section": "Fix", "i_commits": [0]}],

diff --git a/tests/unit/semantic_release/changelog/test_changelog_context.py b/tests/unit/semantic_release/changelog/test_changelog_context.py
@@ -39,7 +39,7 @@ def changelog_tpl_github_context() -> str:
 
         {{ "[Change Summary](%s)" | format("v1.0.0" | compare_url("v2.0.0")) }}
 
-        ### Fixes
+        ### Bug Fixes
 
         - Fixed a minor bug {{ "([#%s](%s))" | format(22, 22 | pull_request_url) }}
         - **cli:** fix a problem {{ "([%s](%s))" | format("000000", "000000" | commit_hash_url) }}
@@ -62,7 +62,7 @@ def changelog_tpl_gitea_context() -> str:
 
         ## v2.0.0
 
-        ### Fixes
+        ### Bug Fixes
 
         - Fixed a minor bug {{ "([#%s](%s))" | format(22, 22 | pull_request_url) }}
         - **cli:** fix a problem {{ "([%s](%s))" | format("000000", "000000" | commit_hash_url) }}
@@ -87,7 +87,7 @@ def changelog_tpl_gitlab_context() -> str:
 
         {{ "[Change Summary](%s)" | format("v1.0.0" | compare_url("v2.0.0")) }}
 
-        ### Fixes
+        ### Bug Fixes
 
         - Fixed a minor bug {{ "([#%s](%s))" | format(22, 22 | merge_request_url) }}
         - Fixed a performance bug {{ "([#%s](%s))" | format(25, 25 | pull_request_url) }}
@@ -113,7 +113,7 @@ def changelog_tpl_bitbucket_context() -> str:
 
         {{ "[Change Summary](%s)" | format("v1.0.0" | compare_url("v2.0.0")) }}
 
-        ### Fixes
+        ### Bug Fixes
 
         - Fixed a minor bug {{ "([#%s](%s))" | format(22, 22 | pull_request_url) }}
         - **cli:** fix a problem {{ "([%s](%s))" | format("000000", "000000" | commit_hash_url) }}
@@ -197,7 +197,7 @@ def test_changelog_context_bitbucket(
             "",
             f'[Change Summary]({hvcs.compare_url("v1.0.0", "v2.0.0")})',
             "",
-            "### Fixes",
+            "### Bug Fixes",
             "",
             f"- Fixed a minor bug ([#22]({hvcs.pull_request_url(22)}))",
             f'- **cli:** fix a problem ([000000]({hvcs.commit_hash_url("000000")}))',
@@ -241,7 +241,7 @@ def test_changelog_context_github(
             "",
             f'[Change Summary]({hvcs.compare_url("v1.0.0", "v2.0.0")})',
             "",
-            "### Fixes",
+            "### Bug Fixes",
             "",
             f"- Fixed a minor bug ([#22]({hvcs.pull_request_url(22)}))",
             f'- **cli:** fix a problem ([000000]({hvcs.commit_hash_url("000000")}))',
@@ -287,7 +287,7 @@ def test_changelog_context_gitea(
             "",
             "## v2.0.0",
             "",
-            "### Fixes",
+            "### Bug Fixes",
             "",
             f"- Fixed a minor bug ([#22]({hvcs.pull_request_url(22)}))",
             f'- **cli:** fix a problem ([000000]({hvcs.commit_hash_url("000000")}))',
@@ -335,7 +335,7 @@ def test_changelog_context_gitlab(
             "",
             f'[Change Summary]({hvcs.compare_url("v1.0.0", "v2.0.0")})',
             "",
-            "### Fixes",
+            "### Bug Fixes",
             "",
             f"- Fixed a minor bug ([#22]({hvcs.merge_request_url(22)}))",
             f"- Fixed a performance bug ([#25]({hvcs.pull_request_url(25)}))",

diff --git a/tests/unit/semantic_release/commit_parser/test_angular.py b/tests/unit/semantic_release/commit_parser/test_angular.py
@@ -64,7 +64,7 @@ def test_parser_returns_correct_bump_level(
     "message, type_",
     [
         ("feat(parser): ...", "features"),
-        ("fix(parser): ...", "fixes"),
+        ("fix(parser): ...", "bug fixes"),
         ("test(parser): ...", "testing"),
         ("docs(parser): ...", "documentation"),
         ("style(parser): ...", "code style"),