ci: add convertional commit lint

shoothzj commented 3 months ago

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:

[x] Read the Contributing Guide before making this pull request.
[x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
[x] Write necessary unit tests to verify the code.
[x] Run mvn clean test to 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

Chores
- Updated commit message conventions to adhere to the conventional commits format and provided guidelines for addressing existing issues in commit messages.
- Established a GitHub Actions workflow named "commit lint" to enforce commit message standards using the commitlint-github-action action.
- Updated the version of the actions/checkout action from v2 to v4 in relevant GitHub Actions workflows.

coderabbitai[bot] commented 3 months ago

Walkthrough

This 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 commitlint-github-action, this workflow ensures consistency and clarity in commit messages, enhancing project management and historical tracking.

Changes

File Path	Change Summary
`.github/workflows/.../commit_lint.yml`	Sets up a workflow for linting commit messages on PRs.
`.github/workflows/build.yml` `.github/workflows/license.yml`	Updated `actions/checkout` action from `v2` to `v4`.
`CONTRIBUTING.md`	Updated commit message conventions to adhere to conventional commits format and provided guidelines for addressing issues in commit messages.

Related issues

apolloconfig/apollo#2037: This PR indirectly supports maintaining clear and consistent commit messages, enhancing tracking changes over time.

Poem

In the realm of code, where logic thrives,
A rabbit dances, ensuring our archives.
"Commit with grace," it whispers low,
History's tale in each line we sow.
🐇✨ Our changes speak, a story so grand,
With clarity and care, we shape the land.

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 50.30%. Comparing base (353f997) to head (f4cf51b).

Additional details and impacted files

```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

nobodyiam commented 3 months ago

This looks good, would you please also help to update the CONTRIBUTING.md accordingly?

apolloconfig / apollo