Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👷 add commit-lint job #176

Merged
merged 1 commit into from
Nov 4, 2023
Merged

👷 add commit-lint job #176

merged 1 commit into from
Nov 4, 2023

Conversation

ccamel
Copy link
Owner

@ccamel ccamel commented Nov 4, 2023

Self explanatory.

Summary by CodeRabbit

  • Chores
    • Implemented a new job "lint-commits" to the workflow for better commit message quality.
    • Added a new configuration for commitlint to enforce commit message standards.

@ccamel ccamel self-assigned this Nov 4, 2023
Copy link

coderabbitai bot commented Nov 4, 2023

Walkthrough

The changes introduced a new linting job for commit messages in the GitHub workflow and added a configuration for commitlint. The linting job checks out the repository and validates the commits, while the configuration sets rules for commit messages. No existing code logic or functionality was modified.

Changes

File Summary
.github/workflows/lint.yml Added a new job "lint-commits" to the workflow. This job runs on "ubuntu-22.04" and includes two steps: checking out the repository and validating the commits.
commitlint.config.js Introduced a new configuration for commitlint. It extends the @commitlint/config-conventional configuration and sets up rules for commit messages, including header patterns, subject case, type enumeration, and header maximum length.

Poem

🍂 As autumn leaves fall, so do old ways, 🍁

In the world of code, a new day dawns. 🌅

Commit messages, once wild and free, 📜

Now follow rules, as they ought to be. 📏

Emojis join the fun, in type enumeration, 🎉

Making commits a cause for celebration. 🥳

So here's to change, and to setting things right, 🥂

CodeRabbit hops on, into the night. 🐇🌙


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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.
  • 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

@ccamel ccamel marked this pull request as ready for review November 4, 2023 11:50
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b81b9ad and 652bb4b.
Files selected for processing (2)
  • .github/workflows/lint.yml (1 hunks)
  • commitlint.config.js (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/workflows/lint.yml
  • commitlint.config.js

@ccamel ccamel merged commit 11b8328 into main Nov 4, 2023
9 checks passed
@ccamel ccamel deleted the ci/commit-lint branch November 4, 2023 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant