Skip to content
This repository has been archived by the owner on Jan 1, 2025. It is now read-only.

add conventional commit message for github. #4

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

iconized
Copy link
Contributor

@iconized iconized commented Jun 2, 2024

No description provided.

iconized added 2 commits June 3, 2024 00:38
Signed-off-by: Abhiraj Roy <157954129+iconized@users.noreply.github.com>
…pull

Signed-off-by: Abhiraj Roy <157954129+iconized@users.noreply.github.com>
Copy link

coderabbitai bot commented Jun 2, 2024

Walkthrough

The recent updates introduce a GitHub Actions workflow to enforce Commitizen conventions on commit messages for the master branch. Additionally, a Bash script named iconfig.sh is included to configure Git user credentials globally. These changes aim to standardize commit messages and streamline Git configuration.

Changes

File Change Summary
.github/workflows/commitizen.yml Introduced a GitHub Actions workflow for checking commit messages against Commitizen conventions.
iconfig.sh Added a Bash script to configure global Git user name and email.

Sequence Diagram(s) (Beta)

sequenceDiagram
    actor Developer
    participant GitHub Actions
    participant GitHub Repository

    Developer->>GitHub Repository: Push/Pull Request to master
    GitHub Actions->>GitHub Repository: Trigger workflow
    GitHub Actions->>GitHub Actions: Checkout repository
    GitHub Actions->>GitHub Actions: Install Node.js
    GitHub Actions->>GitHub Actions: Install Commitizen
    GitHub Actions->>GitHub Actions: Verify commit messages
    GitHub Actions-->>Developer: Commit message verification result
Loading

Poem

In the world of code, we now align,
Commitizen checks, a paradigm.
With scripts to set our Git so fine,
Our commits now in perfect line.
🌟✨
A bunny's joy, in code divine.
🌟✨


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
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 <commit_id>.
    • Generate unit testing code 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 testing code 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 testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e884481 and 599ab93.

Files selected for processing (2)
  • .github/workflows/commitizen.yml (1 hunks)
  • iconfig.sh (1 hunks)
Files skipped from review due to trivial changes (1)
  • iconfig.sh
Additional comments not posted (3)
.github/workflows/commitizen.yml (3)

3-9: Trigger configuration looks good and correctly targets the master branch for both push and pull_request events.


11-14: Job configuration is appropriate and well-defined.


16-26: Steps for checking out the repository and installing Node.js and Commitizen are correctly configured.

.github/workflows/commitizen.yml Show resolved Hide resolved
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant