feat: support new pre-commit hook check-merge-base - #197
Conversation
Sorry, something went wrong.
WalkthroughThe changes involve the addition of a new pre-commit hook named check-merge-base in the .pre-commit-hooks.yaml file, which enforces that the current branch must be rebased onto the target branch. The README.rst file has also been updated to reflect this new hook, including modifications to the command used in the Git hooks section to incorporate the --merge-base option. Minor formatting adjustments were made to ensure consistency. Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? ❤️ Share 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (.coderabbit.yaml)
Documentation and Community
|
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3).pre-commit-hooks.yaml (1)📜 Review detailsREADME.rst (2)37-43: Consider enhancing the hook configuration.
A few suggestions to improve the hook:
- Consider adding a stages field to explicitly define when this hook should run (like the check-message hook does).
- The description could be more specific about how the target branch is determined.
Example enhancement:
- id: check-merge-base name: check merge base - description: requiring to rebase current branch onto target branch + description: requiring current branch to be rebased onto the target branch (specified via --target-branch or default) entry: commit-check args: [--merge-base] pass_filenames: false language: python + stages: [commit, manual]35-35: Fix typo in alternative tools comparison
There's a typo in the word "puglin" which should be "plugin".
-As an alternative to GitHub Enterprise `Metadata restrictions <https://docs.github.com/en/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions>`_ and Bitbucket's paid puglin `Yet Another Commit Checker <https://marketplace.atlassian.com/apps/1211854/yet-another-commit-checker?tab=overview&hosting=datacenter>`_, Commit Check stands out by integrating DevOps principles and Infrastructure as Code (IaC). +As an alternative to GitHub Enterprise `Metadata restrictions <https://docs.github.com/en/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions>`_ and Bitbucket's paid plugin `Yet Another Commit Checker <https://marketplace.atlassian.com/apps/1211854/yet-another-commit-checker?tab=overview&hosting=datacenter>`_, Commit Check stands out by integrating DevOps principles and Infrastructure as Code (IaC).
78-78: Add description for the new hook
The new check-merge-base hook is added without any description. Consider adding a brief comment explaining what this hook does, similar to the comment for check-message. This will help users understand its purpose.
- id: check-merge-base + - id: check-merge-base # ensures current branch is rebased onto target branch
Configuration used: CodeRabbit UI
Review profile: CHILL
Reviewing files that changed from the base of the PR and between 67a6560 and a47310f.
📒 Files selected for processing (2)- .pre-commit-hooks.yaml (1 hunks)
- README.rst (3 hunks)
37-43: LGTM! Hook configuration follows established patterns.
The new hook configuration is well-structured and consistent with existing hooks in the file. It properly integrates with the commit-check tool and aligns with the PR objectives.
README.rst (1)111-111: LGTM! Command updated to support merge-base check
The Git hooks command has been correctly updated to include the new --merge-base option.
Let's verify the command-line option is properly implemented:
✅ Verification successfulLGTM! Command updated to support merge-base check
The Git hooks command has been correctly updated to include the new --merge-base option.
🏁 Scripts executedThe following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the --merge-base option is implemented in the code
# Search for merge-base option handling in Python files
rg -t py "merge.?base" -A 5
Length of output: 11661
Sorry, something went wrong.
|
Sorry, something went wrong.
|
⚠️ Please install the Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #197 +/- ##
=======================================
Coverage 97.27% 97.27%
=======================================
Files 7 7
Lines 294 294
=======================================
Hits 286 286
Misses 8 8 ☔ View full report in Codecov by Sentry. |
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1).pre-commit-config.yaml (1)📜 Review details39-42: LGTM! New hooks are properly configured
The new hooks (check-author-name, check-author-email, and check-merge-base) are:
- Correctly formatted and consistent with existing patterns
- Commented out by default, following the established convention
- Properly aligned with the PR objectives for adding merge-base functionality
Consider adding a comment explaining what the check-merge-base hook does, similar to how other hooks in the file have explanatory comments.
Configuration used: CodeRabbit UI
Review profile: CHILL
Reviewing files that changed from the base of the PR and between a47310f and 6bba256.
📒 Files selected for processing (2)- .pre-commit-config.yaml (1 hunks)
- .pre-commit-hooks.yaml (1 hunks)
- .pre-commit-hooks.yaml
35-35: Verify the stability of commit-check v0.9.1
Let's ensure this version is stable and contains the new hooks mentioned in the PR.
✅ Verification successfulcommit-check v0.9.1 is stable and free of known issues.
🏁 Scripts executedThe following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the commit-check version and its changelog
# Check the latest version and tags
gh api repos/commit-check/commit-check/tags --jq '.[0:3] | .[] | {name, commit: .commit.sha}'
# Check for any reported issues with v0.9.1
gh api search/issues -X GET -f q="repo:commit-check/commit-check is:issue label:bug v0.9.1"
Length of output: 455
Sorry, something went wrong.
closes #195
Summary by CodeRabbit
New Features
Documentation