chore(commitlint): add commit-msg hook and workflow validation#134
chore(commitlint): add commit-msg hook and workflow validation#134DurgaPrasad-54 wants to merge 3 commits intoPSMRI:mainfrom
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe changes migrate commit validation from local Husky pre-commit hooks to a custom Changes
Sequence DiagramssequenceDiagram
actor Dev as Developer
participant LocalHooks as .git-hooks/commit-msg
participant Git as Git Repo
participant CI as GitHub Actions
participant Lint as commitlint
Dev->>Dev: Create commit
Dev->>Git: git commit
Git->>LocalHooks: Execute commit-msg hook
LocalHooks->>Lint: Validate message
alt Hook passes
Lint-->>LocalHooks: Exit 0
LocalHooks-->>Git: Allow commit
Git->>CI: Push to PR
CI->>Lint: Per-commit validation
Lint-->>CI: Exit 0
CI->>CI: Workflow passes
else Hook fails
Lint-->>LocalHooks: Exit 1
LocalHooks-->>Git: Block commit
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
43-44: Consider documenting commit message format.The removed "Setting Up Commit Hooks" section included commit message conventions. Consider adding a brief note about the expected format (e.g.,
type(scope): subject) and valid types, or link to thecommitlint.config.jsfile so contributors know the rules.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 43 - 44, The README currently instructs enabling git hooks but omits the project's commit message convention; add a short section or sentence describing the expected commit message format (for example "type(scope): subject") and list the valid types or link to the commitlint configuration by referencing commitlint.config.js so contributors can see the full rules; mention where to find the hook (core.hooksPath or .git-hooks) only as context and keep the guidance concise.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 46-49: Update the fenced code block containing the command "mvn
clean install" to include a language specifier (e.g., bash) after the opening
backticks so the block becomes ```bash and satisfies MD040; locate the markdown
block that shows the mvn clean install command and add the language token only
(no other changes).
---
Nitpick comments:
In `@README.md`:
- Around line 43-44: The README currently instructs enabling git hooks but omits
the project's commit message convention; add a short section or sentence
describing the expected commit message format (for example "type(scope):
subject") and list the valid types or link to the commitlint configuration by
referencing commitlint.config.js so contributors can see the full rules; mention
where to find the hook (core.hooksPath or .git-hooks) only as context and keep
the guidance concise.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c1bb27ec-1ce3-4e29-b956-7dbffede1d7a
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (7)
.git-hooks/commit-msg.github/workflows/commit-lint.yml.husky/commit-msg.husky/pre-commitREADME.mdcommitlint.config.jspackage.json
💤 Files with no reviewable changes (3)
- .husky/pre-commit
- .husky/commit-msg
- package.json
|
1 participant
📋 Description
JIRA ID:
Add the commit message validation setup by defining the commit rules directly in commitlint.config.js instead of extending @commitlint/config-conventional.
✅ Type of Change
Summary by CodeRabbit
Release Notes
Chores
Documentation