SYS-8736 open-source exempt from Jira validation, added regression te… - #45
Open
mmaharjan-ccdc wants to merge 3 commits into
Open
mmaharjan-ccdc wants to merge 3 commits into
mmaharjan-ccdc wants to merge 3 commits into
Conversation
…sts for Opensource, and unsupported types
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
README documentation does not yet match the validator’s Jira exemption and accepted commit forms.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Updates commit validation so open-source repositories skip Jira checks while still enforcing opted-in Conventional Commits rules.
Changes:
- Narrows the open-source Jira exemption.
- Adds regression tests for open-source and unsupported commit types.
- Documents Conventional Commits configuration and supported types.
File summaries
| File | Summary |
|---|---|
README.md |
Adds Conventional Commits documentation. |
main/githooks.py |
Adjusts Jira validation and adds regression tests. |
Review details
Suppressed comments (2)
README.md:35
- The documented supported-type list does not match the validator:
conventional_commit_presentalso accepts aBREAKING CHANGE: ...header via its regex, even though this list omits it andbreakis described as the major-version marker. Either reject that header or document it explicitly; otherwise the README and the unsupported-type regression do not describe the actual enforcement.
Supported types are `break`, `feat`, `fix`, `refactor`, `build`, `chore`, `ci`,
`docs`, `perf`, `revert`, `style`, and `test`. CCDC release configurations use
`break` for a major version. A branch may contain more than one type.
Releases should choose the highest required version bump,
so `break` takes precedence over `feat`, which takes precedence over `fix`.
README.md:25
- This new section does not document the new
ccdc-opensource/*Jira exemption, while the overview immediately above still says commits without a Jira ID are flagged. Update the Jira description and add the exception so open-source contributors are not given inaccurate validation requirements.
Conventional Commits validation is optional. Add a `.conventional-commits` file
at the repository root to enable it. The supported header format is:
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…sts for Opensource, and unsupported types