ci: add convertional commit lint #5111
Conversation
dosubot
bot
added
the
size:S
WalkthroughThis update brings a new GitHub Actions workflow named "commit lint" to enforce commit message standards on pull requests to the main branch. By leveraging the Changes
Related issues
Poem
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? 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5111 +/- ##
=========================================
Coverage 50.30% 50.30%
Complexity 2011 2011
=========================================
Files 388 388
Lines 12216 12216
Branches 1207 1207
=========================================
Hits 6145 6145
Misses 5708 5708
Partials 363 363 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- .github/workflows/commit_lint.yml (1 hunks)
Additional comments: 1
.github/workflows/commit_lint.yml (1)
- 1-12: The workflow configuration looks good and is well-structured for the purpose of linting commit messages according to the conventional commit guidelines. It correctly triggers on pull requests to the main branch and includes appropriate steps for checking out the code and running the commit linting action. Great job on setting this up!
|
This looks good, would you please also help to update the CONTRIBUTING.md accordingly? |
hezhangjian
force-pushed
the
add-commit-lint
branch
from
c592db5 to
22f0145
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (4)
- .github/workflows/build.yml (1 hunks)
- .github/workflows/commit_lint.yml (1 hunks)
- .github/workflows/license.yml (1 hunks)
- CONTRIBUTING.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/commit_lint.yml
Additional comments: 4
.github/workflows/license.yml (1)
- 31-31: The update of
actions/checkouttov4is a good practice for taking advantage of the latest features and security improvements. Ensure that there are no breaking changes betweenv2andv4that could affect the workflow..github/workflows/build.yml (1)
- 34-34: The update of
actions/checkouttov4is recommended to leverage the latest features and improvements. Please ensure compatibility with the workflow and that there are no breaking changes affecting the build process.CONTRIBUTING.md (2)
- 35-35: Introducing guidelines for conventional commits is a great improvement. Consider adding examples of conventional commit messages to provide clear models for contributors.
- 37-37: Providing guidelines for commit messages that address existing issues is beneficial for project tracking. Ensure that the instructions are clear and easy to follow for contributors.
Signed-off-by: ZhangJian He <[email protected]>
nobodyiam
force-pushed
the
add-commit-lint
branch
from
22f0145 to
f4cf51b
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (4)
- .github/workflows/build.yml (1 hunks)
- .github/workflows/commit_lint.yml (1 hunks)
- .github/workflows/license.yml (1 hunks)
- CONTRIBUTING.md (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- .github/workflows/build.yml
- .github/workflows/commit_lint.yml
- .github/workflows/license.yml
Additional comments: 3
CONTRIBUTING.md (3)
- 32-37: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [17-17]
The term "Javadocs" is correctly spelled, but consider clarifying its usage if it's not widely understood among potential contributors.
- 32-37: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [28-28]
The term "fixup" is correctly used in the context of Git commands. No change is necessary.
- 35-37: The addition of conventional commit guidelines is a positive change. Ensure that the link to Conventional Commits is accessible and that the guidelines are clear and easy to follow for contributors.
| * `git checkout -b <some-branch-name> <remote>/master` | ||
| * `git merge --squash <current-feature-branch>` | ||
|
|
||
| * When writing a commit message please follow these conventions: if you are fixing an existing issue, please add Fixes #XXX at the end of the commit message (where XXX is the issue number). | ||
| * For commits, we adhere to the conventional commits format. For more details, refer to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). | ||
|
|
||
| * When crafting commit messages, please adhere to the following conventions: if your commit addresses an existing issue, append "Fixes #XXX" to the end of the commit message (where XXX is the issue number). |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [3-3]
Consider adding a comma for clarity: "...contribute even something trivial, please do not hesitate..."
- If you want to contribute even something trivial please do not hesitate
+ If you want to contribute even something trivial, please do not hesitate📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [7-7]
A comma might improve readability: "...non-trivial patch or pull request, we will need you to sign..."
- Before we accept a non-trivial patch or pull request we will need you to sign
+ Before we accept a non-trivial patch or pull request, we will need you to sign
What's the purpose of this PR
introduce conventional commit in apolloconfig[1]. It will looks like[2]
Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean testto make sure this pull request doesn't break anything.[1] https://www.conventionalcommits.org/en/v1.0.0/
[2] https://github.com/openGemini/opengemini-client-go/commits/main/
Summary by CodeRabbit
commitlint-github-actionaction.actions/checkoutaction fromv2tov4in relevant GitHub Actions workflows.