chore(ci): add semantic PR and release workflows

[MSevey]

Overview

Summary by CodeRabbit

• New Features

  • Introduced a new GitHub Actions workflow for semantic pull requests, enhancing the pull request process with automated checks.
  • Added a GitHub Actions workflow for semantic release, automating the release process upon pushes to the main branch.

• Documentation

  • Updated workflow files to improve clarity and functionality in the release and pull request processes.

[coderabbitai]

Note

Reviews paused

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Walkthrough

Two new GitHub Actions workflow files have been introduced: semantic_pull_request.yml and semantic_release.yml. The semantic_pull_request.yml workflow is triggered by specific pull request events and sets permissions for read access, while the semantic_release.yml workflow automates the release process upon pushes to the main branch. Each workflow consists of a single job running on Ubuntu, with defined steps for actions like checking out code and configuring Semantic Release settings.

Changes

File Path	Change Summary
.github/workflows/semantic_pull_request.yml	New workflow added to handle pull request events with permissions and a job utilizing amannn/action-semantic-pull-request@v5.
.github/workflows/semantic_release.yml	New workflow added to automate the release process on pushes to the main branch, including checkout and Semantic Release configuration.

Poem

🐇 In the meadow where changes bloom,
New workflows dance, dispelling gloom.
Pull requests sing, releases take flight,
With every push, our code shines bright!
Hooray for the updates, let’s hop with glee,
For seamless releases, we’re as happy as can be! 🌼

---

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: 3

🧹 Outside diff range and nitpick comments (1)

.github/workflows/semantic_release.yml (1)

14-17: Move semantic-release configuration to a dedicated file

While the inline configuration works, it would be better to maintain it in a dedicated .releaserc.json file for better maintainability and version control.

Create a .releaserc.json file in the repository root with:

{
  "branches": [],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/github"
  ]
}

Then simplify the workflow step to:

- run: echo '{"branches":[],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/github"]}' > .releaserc.json
+ run: echo "Semantic release configuration loaded from .releaserc.json"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d5e0a3b and a254978.

📒 Files selected for processing (2)

• .github/workflows/semantic_pull_request.yml (1 hunks)
• .github/workflows/semantic_release.yml (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .github/workflows/semantic_pull_request.yml

🔇 Additional comments (1)

.github/workflows/semantic_release.yml (1)

1-24: Verify semantic-release dependencies installation

The workflow assumes semantic-release and its plugins are available. These need to be installed before running semantic-release.

Add this script to verify the presence of required actions and their versions:

[MSevey]

@coderabbitai resolve

[MSevey]

@coderabbitai ignore

[coderabbitai]

✅ Actions performed

Comments resolved.

[coderabbitai]

✅ Actions performed

Reviews paused.