.github/workflows/commit-check.yml (1)

27-27: Add inline documentation for the merge-base parameter

The purpose and behavior of this new parameter should be documented in the workflow file for better maintainability.

Add a comment explaining the parameter:

+          # Validates if the current branch is properly rebased onto the target branch
           merge-base: true

.commit-check.yml (2)

26-26: Remove unnecessary empty line

The empty line between checks affects readability and isn't consistent with the spacing between other checks.

   suggest: run command `git config user.email yourname@example.com`
-

  - check: merge_base

---

29-30: Improve error and suggestion messages with more specific guidance

The current messages could be more helpful by including specific commands and the target branch name.

-    error: Current branch is not rebased onto target branch
-    suggest: please ensure your branch is rebased with the target branch
+    error: Current branch is not rebased onto the target branch (${TARGET_BRANCH})
+    suggest: Run these commands to rebase:\n  git fetch origin ${TARGET_BRANCH}\n  git rebase origin/${TARGET_BRANCH}

action.yml (1)

Line range hint 52-61: Critical: Missing environment variable for merge-base input

The merge-base input parameter needs to be passed to the Python script through an environment variable, similar to other inputs.

Add the missing environment variable mapping:

      env:
        MESSAGE: ${{ inputs.message }}
        BRANCH: ${{ inputs.branch }}
        AUTHOR_NAME: ${{ inputs.author-name }}
        AUTHOR_EMAIL: ${{ inputs.author-email }}
        COMMIT_SIGNOFF: ${{ inputs.commit-signoff }}
        DRY_RUN: ${{ inputs.dry-run }}
        JOB_SUMMARY: ${{ inputs.job-summary }}
        PR_COMMENTS: ${{ inputs.pr-comments }}
+       MERGE_BASE: ${{ inputs.merge-base }}

main.py (1)

Line range hint 41-63: Consider adding docstring for merge-base functionality

While the implementation is solid, it would be helpful to add documentation explaining:

• The purpose of the merge-base check
• Expected values and behavior
• Impact on the overall commit check process

Add a docstring to explain the merge-base functionality:

 def run_commit_check() -> int:
-    """Runs the commit-check command and logs the result."""
+    """Runs the commit-check command and logs the result.
+    
+    The following checks are performed:
+    - Message format validation
+    - Branch naming convention
+    - Author name and email verification
+    - Commit sign-off requirement
+    - Merge base validation (ensures current branch is rebased onto target branch)
+    
+    Returns:
+        int: The return code from the commit-check command execution
+    """

README.md (2)

76-82: Improve documentation clarity and fix grammar issues.

The documentation for the new merge-base parameter needs some improvements:

1. Fix grammar: "disable" should be "disabled"
2. Fix capitalization: "by default" should be "By default"
3. Add more context about what "rebased onto target branch" means and its implications

Apply this diff:

 ### `merge-base`

 - **Description**: check current branch is rebased onto target branch.
 - Default: 'false'

 > [!IMPORTANT]
-> `merge-base` is an experimental feature. by default it's disable.
+> `merge-base` is an experimental feature. By default it's disabled. When enabled, it ensures your branch contains all commits from the target branch, helping prevent merge conflicts and maintain a clean git history.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~82-~82: A comma is probably missing here.
Context: ...ge-baseis an experimental feature. by default it's disable. ###dry-run` - **Descr...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)

---

100-102: Fix grammar and capitalization in the important notice.

The notice about the experimental pr-comments feature needs some improvements:

Apply this diff:

 > [!IMPORTANT]
-> `pr-comments` is an experimental feature. by default it's disable. To use it you need to set `GITHUB_TOKEN` in the GitHub Action.
+> `pr-comments` is an experimental feature. By default it's disabled. To use it, you need to set `GITHUB_TOKEN` in the GitHub Action.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~100-~100: A comma is probably missing here.
Context: ...omments` is an experimental feature. by default it's disable. To use it you need to set...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)

---

[typographical] ~100-~100: It seems that a comma is missing.
Context: ...eature. by default it's disable. To use it you need to set GITHUB_TOKEN in the G...

(IN_ORDER_TO_VB_COMMA)

Configuration used: CodeRabbit UI
Review profile: CHILL

#!/bin/bash
# Description: Check naming consistency
# Expected: Should show all occurrences of both merge-base and merge_base

# Search for both naming conventions
echo "Hyphenated format:"
rg "merge-base"

echo -e "\nUnderscore format:"
rg "merge_base"

README.md (2)

76-84: Fix grammatical issues in merge-base documentation

There are several grammatical issues in the documentation that should be addressed.

- > `merge-base` is an experimental feature. by default it's disable.
- > To use this feature, you need fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`.
+ > `merge-base` is an experimental feature. By default, it's disabled.
+ > To use this feature, you need to fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~82-~82: A comma is probably missing here.
Context: ...ge-base` is an experimental feature. by default it's disable. > > To use this feature,...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)

---

[grammar] ~84-~84: The verb “fetch” needs to be in the to-infinitive form.
Context: ... disable. > > To use this feature, you need fetch all history for all branches by setting...

(MISSING_TO_BEFORE_A_VERB)

---

102-104: Fix grammatical issues in PR comments documentation

Similar grammatical issues need to be addressed in the PR comments section.

- > `pr-comments` is an experimental feature. by default it's disable. To use it you need to set `GITHUB_TOKEN` in the GitHub Action.
+ > `pr-comments` is an experimental feature. By default, it's disabled. To use it, you need to set `GITHUB_TOKEN` in the GitHub Action.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~102-~102: A comma is probably missing here.
Context: ...omments` is an experimental feature. by default it's disable. To use it you need to set...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)

---

[typographical] ~102-~102: It seems that a comma is missing.
Context: ...eature. by default it's disable. To use it you need to set GITHUB_TOKEN in the G...

(IN_ORDER_TO_VB_COMMA)

Configuration used: CodeRabbit UI
Review profile: CHILL

#!/bin/bash
# Description: Verify merge-base parameter configuration
# Expected: Should show merge-base marked as experimental with default: false

# Check action.yml for merge-base input configuration
rg -A 5 "merge-base:" action.yml