diff --git a/main.py b/main.py index effbf5b..6948fc0 100755 --- a/main.py +++ b/main.py @@ -538,22 +538,6 @@ def keep_ai_rules(scope: ScopeResult) -> ScopeResult: return skip_when_no_ai_rule_ran(scope) -#: Rules about a commit rather than about a line of text: it has a body -#: (CC011), a sign-off (CC012), an author that is no AI tool (CC017). A pull -#: request title has neither body nor trailers nor an author of its own, so -#: judged as a commit message it could never pass the first two, and the -#: third would judge whatever git identity the runner has. -COMMIT_ONLY_RULE_IDS = frozenset({"CC011", "CC012", "CC017"}) - - -def drop_commit_only_rules(scope: ScopeResult) -> ScopeResult: - """Narrow the PR title scope to the rules a one-line title can meet.""" - scope.checks = [ - c for c in scope.checks if c.get("rule_id") not in COMMIT_ONLY_RULE_IDS - ] - return scope - - def get_pr_title() -> str | None: """Read PR title from GitHub event payload.""" if not is_pr_event(): @@ -1111,8 +1095,10 @@ def run_commit_check() -> tuple[int, list[ScopeResult]]: if PR_TITLE_ENABLED and is_pr_event(): pr_title = get_pr_title() if pr_title: - scope = check_scope("PR title", ["--message"], input_text=pr_title) - results.append(drop_commit_only_rules(scope)) + # --pr-title runs the --message rules a one-line title can meet: + # none needing a body (CC011), a sign-off (CC012) or an author + # (CC017), and its advice does not say to re-commit. + results.append(check_scope("PR title", ["--pr-title"], input_text=pr_title)) # ---- 2. PR description ------------------------------------------------ if (PR_BODY_AI_ATTRIBUTION_ENABLED or ai_label_name()) and is_pr_event(): @@ -2173,7 +2159,7 @@ def _all_checks(results: list[ScopeResult]) -> list[str]: # # # -# Checked by [Commit Check](https://commit-check.com) 2.21.0 · [Rules](…) · [Check before you push](…) +# Checked by [Commit Check](https://commit-check.com) 2.22.0 · [Rules](…) · [Check before you push](…) # # Success: the heading reads " Commit Check passed", then the # group lines, the folded listing and the footer. No diff, no "How to fix". diff --git a/main_test.py b/main_test.py index 56fed12..a1016e5 100644 --- a/main_test.py +++ b/main_test.py @@ -1003,36 +1003,9 @@ def test_pr_title_check_runs_when_enabled(self): rc, _results = main.run_commit_check() self.assertEqual(rc, 0) mock_scope.assert_called_once_with( - "PR title", ["--message"], input_text="feat: a feature" + "PR title", ["--pr-title"], input_text="feat: a feature" ) - def test_pr_title_is_not_held_to_commit_only_rules(self): - # require_body and require_signed_off_by judge a commit; a title has - # no body or trailers, so it could never pass them. - title = main.ScopeResult( - label="PR title", - checks=[ - make_check("message", "pass", "CC001", value="feat: add login"), - make_check("require_body", "fail", "CC011", value="feat: add login"), - make_check("require_signed_off_by", "fail", "CC012"), - make_check("ai_author", "fail", "CC017", value="Claude "), - ], - ) - with ( - patch("main.PR_TITLE_ENABLED", True), - patch("main.MESSAGE_ENABLED", False), - patch("main.BRANCH_ENABLED", False), - patch("main.AUTHOR_NAME_ENABLED", False), - patch("main.AUTHOR_EMAIL_ENABLED", False), - patch("main.is_pr_event", return_value=True), - patch("main.get_pr_title", return_value="feat: add login"), - patch("main.check_scope", return_value=title), - patch("main.run_other_checks", return_value=[]), - ): - rc, results = main.run_commit_check() - self.assertEqual(rc, 0) - self.assertEqual([c["rule_id"] for c in results[0].checks], ["CC001"]) - def test_pr_title_failure_propagates(self): with ( patch("main.PR_TITLE_ENABLED", True), @@ -4336,9 +4309,9 @@ def setUp(self): env_patch.start() self.addCleanup(env_patch.stop) - def _run(self, message: str) -> tuple[int, dict]: + def _run(self, message: str, check_type: str = "--message") -> tuple[int, dict]: rc, data, raw = main.run_check_json( - ["--message", "--config", self.config], input_text=message + [check_type, "--config", self.config], input_text=message ) self.assertIsInstance(data, dict, f"CLI did not emit JSON:\n{raw}") assert data is not None # for the type checker; asserted above @@ -4382,15 +4355,25 @@ def test_failing_message(self): def test_a_title_meets_only_the_rules_a_title_can(self): with open(self.config, "w", encoding="utf-8") as f: f.write("[commit]\nrequire_body = true\nrequire_signed_off_by = true\n") + # As a commit message the title fails the rules only a commit can meet. rc, data = self._run("feat: add login page") failed = {c["rule_id"] for c in data["checks"] if c["status"] == "fail"} self.assertEqual(rc, 1) self.assertEqual(failed, {"CC011", "CC012"}) - scope = main.drop_commit_only_rules( - main.ScopeResult(label="PR title", checks=data["checks"]) - ) + # --pr-title, which the action runs on a title, leaves them out. + rc, data = self._run("feat: add login page", "--pr-title") + ran = {c["rule_id"] for c in data["checks"]} + self.assertEqual(rc, 0) + self.assertFalse(ran & {"CC011", "CC012", "CC017"}) + scope = main.ScopeResult(label="PR title", checks=data["checks"]) self.assertEqual(scope.status, "pass") + def test_a_bad_title_still_fails(self): + rc, data = self._run("Added login page", "--pr-title") + failed = {c["rule_id"] for c in data["checks"] if c["status"] == "fail"} + self.assertEqual(rc, 1) + self.assertIn("CC001", failed) + class TestStderrIsNotPartOfTheJson(unittest.TestCase): """stdout is the JSON; stderr is what the CLI has to say to a person. diff --git a/requirements.txt b/requirements.txt index 5fcf7af..6a9794d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # Install commit-check CLI # For details please see: https://github.com/commit-check/commit-check -commit-check==2.21.0 +commit-check==2.22.0 # Interact with the GitHub API. PyGithub==2.10.0