chore: 🔨 add PR Conventional Commit Validation workflow for opened PRs

[blackfyre]

Summary by CodeRabbit

• New Features

  • Introduced a new workflow to validate pull request titles against conventional commit standards, enhancing consistency in commit messages.

• Chores

  • Added a GitHub Actions workflow file for automated title validation on pull requests.

[coderabbitai]

Walkthrough

A new GitHub Actions workflow file named pr-title.yml has been added to validate pull request titles against conventional commit standards. This workflow activates on various pull request events such as opening, synchronizing, reopening, or editing. It includes a job called validate-pr-title, which runs on Ubuntu and utilizes the ytanikin/PRConventionalCommits@1.1.0 action to ensure compliance with specified task types.

Changes

File Path	Change Summary
.github/workflows/pr-title.yml	Added a new workflow for validating pull request titles against conventional commit standards.

Poem

In the meadow, hops a rabbit bright,
Validating titles, oh what a sight!
With commits so neat, and rules in play,
Our pull requests shine, come what may!
Hooray for the workflow, let’s hop and cheer,
For tidy titles bring us all near! 🐇✨

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

.github/workflows/pr-title.yml (1)

14-14: Add a newline at the end of the file.

To adhere to common best practices and prevent potential issues with certain tools, please add a newline character at the end of the file.

Here's how you can modify the last line:

-          task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert", "build"]'
+          task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert", "build"]'
+

🧰 Tools

🪛 yamllint

[error] 14-14: no new line character at the end of file

(new-line-at-end-of-file)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1f3265a and 068ba8f.

📒 Files selected for processing (1)

• .github/workflows/pr-title.yml (1 hunks)

🧰 Additional context used

🪛 yamllint

.github/workflows/pr-title.yml

[error] 14-14: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (2)

.github/workflows/pr-title.yml (2)

1-5: LGTM: Workflow name and trigger events are well-defined.

The workflow name accurately describes its purpose, and the trigger events cover all relevant PR actions (opened, synchronize, reopened, and edited). This ensures that the validation runs whenever a PR is created or updated.

---

7-10: LGTM: Job configuration is appropriate.

The job name "validate-pr-title" is clear and descriptive. Using the latest Ubuntu runner is a good practice for most workflows, and having a single step is appropriate for this simple validation task.