commit-check 2.1.2__py3-none-any.whl → 2.2.0__py3-none-any.whl

commit_check/__init__.py

@@ -41,6 +41,8 @@ DEFAULT_BRANCH_TYPES = [
     "feat",
     "fix",
 ]
+# Additional allowed branch names (e.g., develop, staging)
+DEFAULT_BRANCH_NAMES: list[str] = []
 
 # Handle different default values for different rules
 DEFAULT_BOOLEAN_RULES = {

commit_check/rule_builder.py

@@ -6,6 +6,7 @@ from commit_check.rules_catalog import COMMIT_RULES, BRANCH_RULES, RuleCatalogEn
 from commit_check import (
     DEFAULT_COMMIT_TYPES,
     DEFAULT_BRANCH_TYPES,
+    DEFAULT_BRANCH_NAMES,
     DEFAULT_BOOLEAN_RULES,
 )
 
@@ -125,7 +126,8 @@ class RuleBuilder:
             return None
 
         allowed_types = self._get_allowed_branch_types()
-        regex = self._build_conventional_branch_regex(allowed_types)
+        allowed_names = self._get_allowed_branch_names()
+        regex = self._build_conventional_branch_regex(allowed_types, allowed_names)
 
         return ValidationRule(
             check=catalog_entry.check,
@@ -222,12 +224,23 @@ class RuleBuilder:
         types = self.branch_config.get("allow_branch_types", DEFAULT_BRANCH_TYPES)
         return list(dict.fromkeys(types))  # Preserve order, remove duplicates
 
+    def _get_allowed_branch_names(self) -> List[str]:
+        """Get deduplicated list of allowed branch names."""
+        names = self.branch_config.get("allow_branch_names", DEFAULT_BRANCH_NAMES)
+        return list(dict.fromkeys(names))  # Preserve order, remove duplicates
+
     def _build_conventional_commit_regex(self, allowed_types: List[str]) -> str:
         """Build regex for conventional commit messages."""
         types_pattern = "|".join(sorted(set(allowed_types)))
         return rf"^({types_pattern}){{1}}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*)|(Merge).*|(fixup!.*)"
 
-    def _build_conventional_branch_regex(self, allowed_types: List[str]) -> str:
+    def _build_conventional_branch_regex(
+        self, allowed_types: List[str], allowed_names: List[str]
+    ) -> str:
         """Build regex for conventional branch names."""
         types_pattern = "|".join(allowed_types)
-        return rf"^({types_pattern})\/.+|(master)|(main)|(HEAD)|(PR-.+)"
+        # Build pattern for additional allowed branch names
+        base_names = ["master", "main", "HEAD", "PR-.+"]
+        all_names = base_names + allowed_names
+        names_pattern = ")|(".join(all_names)
+        return rf"^({types_pattern})\/.+|({names_pattern})"

commit_check/rules_catalog.py

@@ -112,7 +112,7 @@ BRANCH_RULES = [
         check="branch",
         regex=None,  # Built dynamically from config
         error="The branch should follow Conventional Branch. See https://conventional-branch.github.io/",
-        suggest="Use <type>/<description> with allowed types or ignore_authors in config branch section to bypass",
+        suggest="Use <type>/<description> with allowed types or add branch name to allow_branch_names in config, or use ignore_authors in config branch section to bypass",
     ),
     RuleCatalogEntry(
         check="merge_base",

{commit_check-2.1.2.dist-info → commit_check-2.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commit-check
-Version: 2.1.2
+Version: 2.2.0
 Summary: Check commit message formatting, branch naming, commit author, email, and more.
 Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
 License-Expression: MIT
@@ -33,6 +33,7 @@ Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-codspeed; extra == "test"
 Provides-Extra: docs
+Requires-Dist: sphinx<9; extra == "docs"
 Requires-Dist: sphinx-immaterial; extra == "docs"
 Requires-Dist: sphinx-autobuild; extra == "docs"
 Requires-Dist: sphinx_issues; extra == "docs"

commit_check-2.2.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+commit_check/__init__.py,sha256=6bUw-6fUjCN5qAxe6i4mUztQiAHpjOhyPHsegW1tbBc,1297
+commit_check/config.py,sha256=1Th_57ekaYorJFLpSjZq-HW5U5iuVGYWBBAUj8kp9pI,961
+commit_check/engine.py,sha256=P7hp-b5I8HwRsQPWJnKFXwTza0rXqp_xepuoN1grPqA,19340
+commit_check/imperatives.py,sha256=b_olcxhoHW2LMHaO9COVlVUdLE-7uifo9WeSY7rPql4,3582
+commit_check/main.py,sha256=JTlDLzUVAszcP0Faug25bIaBpUqqFG_CKkrDFOSzwB8,6977
+commit_check/rule_builder.py,sha256=0UqMQxDiPNgqEjmRTYnyHimCA7vZRZqgqdm7ughp3DY,9205
+commit_check/rules_catalog.py,sha256=95aXG0CzeUzEokyVwhyC5EnqCD0euDtdGlDBU2W498Y,4280
+commit_check/util.py,sha256=bvB4w0jSdgot5eOThmn9iV1IwKjBX_B8hB2T9hhrskQ,8340
+commit_check-2.2.0.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
+commit_check-2.2.0.dist-info/METADATA,sha256=BbavslIOcQzXNo0aKVA1FNEvsOMRp-VdUOSRH9279GM,9453
+commit_check-2.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+commit_check-2.2.0.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
+commit_check-2.2.0.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
+commit_check-2.2.0.dist-info/RECORD,,

commit_check-2.1.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-commit_check/__init__.py,sha256=v0dHxQIC-oSKPspRnLK0lPijrJcYIZQuPIvnMW-dvss,1201
-commit_check/config.py,sha256=1Th_57ekaYorJFLpSjZq-HW5U5iuVGYWBBAUj8kp9pI,961
-commit_check/engine.py,sha256=P7hp-b5I8HwRsQPWJnKFXwTza0rXqp_xepuoN1grPqA,19340
-commit_check/imperatives.py,sha256=b_olcxhoHW2LMHaO9COVlVUdLE-7uifo9WeSY7rPql4,3582
-commit_check/main.py,sha256=JTlDLzUVAszcP0Faug25bIaBpUqqFG_CKkrDFOSzwB8,6977
-commit_check/rule_builder.py,sha256=GaThCjaUfktkuK_1CUs4LEjnlyqCouRfRUQQ0GUwrjU,8592
-commit_check/rules_catalog.py,sha256=FryaCoxAj9V-2c9GJGuzA8MTy8jcfgrBvN3SKlnlLHw,4224
-commit_check/util.py,sha256=bvB4w0jSdgot5eOThmn9iV1IwKjBX_B8hB2T9hhrskQ,8340
-commit_check-2.1.2.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
-commit_check-2.1.2.dist-info/METADATA,sha256=otDs3t0GRf4eVIMfSDtIdRsfIzqqnoBnhPSnX0QfHwU,9412
-commit_check-2.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-commit_check-2.1.2.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
-commit_check-2.1.2.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
-commit_check-2.1.2.dist-info/RECORD,,