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

🔧 Adopt gitmoji (+ some others upptime emojis) #8

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Nov 2, 2023

Transition to gitmoji-style for commit messages as this is the default practice for upptime. Accordingly, the linter configuration has be configured to accommodate the use of emojis.

Summary by CodeRabbit

Chores:

  • Updated the linting workflow in GitHub Actions. The lint-commits job will now run for all contributors, including 'upptime-bot', enhancing the consistency of code quality checks across all commits.
  • Added a new configuration for commitlint in commitlint.config.js. This includes rules for subject case, type enumeration, and header maximum length, improving the clarity and consistency of commit messages. The type enumeration now supports a variety of emoji and Unicode characters, allowing for more expressive commit messages.

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

coderabbitai bot commented Nov 2, 2023

Walkthrough

The changes primarily focus on refining the linting process in the GitHub workflow and commitlint configuration. The workflow now includes all actors, except dependabot[bot], and the commitlint configuration has been extended with new rules and parser options, including emoji and Unicode character support.

Changes

File Path Summary
.github/workflows/lint.yml Removed the condition github.actor != 'upptime-bot' from the lint-commits job, allowing the job to run for all actors except dependabot[bot].
commitlint.config.js Added a new module export configuration for commitlint. It extends the @commitlint/config-conventional configuration and sets up parser options for header patterns and correspondence. Defined rules for subject case, type enumeration, and header maximum length. The type enumeration includes a list of emoji and Unicode characters.

🍂 As the leaves fall, so do the old rules, 🍁

Making way for the new, as the coder's tools. 🛠️

Emojis and Unicodes, now join the fray, 🎉

In the world of code, they've found their way. 💻

So here's to changes, big and small, 🥂

To the coder's journey, we toast them all. 🍻


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

@ccamel ccamel marked this pull request as ready for review November 2, 2023 19:22
@ccamel ccamel requested a review from amimart November 2, 2023 19:22
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 8f9ccfb and 7488e43.
Files selected for processing (2)
  • .github/workflows/lint.yml (1 hunks)
  • commitlint.config.js (1 hunks)
Files skipped from review due to trivial changes (1)
  • commitlint.config.js
Additional comments: 1
.github/workflows/lint.yml (1)
  • 12-18: The lint-commits job now runs for all actors except dependabot[bot]. Ensure that this change doesn't introduce any unwanted behavior, especially if upptime-bot was previously excluded for a specific reason.

Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

Love that 😉

@ccamel ccamel merged commit 6f8dc5a into main Nov 3, 2023
7 of 8 checks passed
@ccamel ccamel deleted the build/gitmoji-commitlint branch November 3, 2023 08:03
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.

2 participants