feat(ci): Add semantic PR action and semantic release

[MSevey]

Overview

This PR introduces an option for auto semantic releases and the prerequisite semantic PR action.

The semantic release action will trigger on fix and feat commits to main creating patch and minor releases respectively.

To trigger a major release, you can add BREAKING CHANGE in the commit message during the merge, see screenshot.

It is important to note that by default the breaking change will trigger a major release, so while we are on v0.x we should avoid triggering the major releases until we have released a v1.

In my testing, I did not see the workflow trigger a release on chore, test, or docs commits. So it is important that when submitting and review PRs are are consistent in our semantic commit usage to ensure releases are triggered as intended.

Summary by CodeRabbit

• New Features
  • Introduced a GitHub Actions workflow for enforcing semantic pull request practices, enhancing commit message consistency.
  • Added a workflow for automating semantic versioning and release management, streamlining the release cycle based on commit messages.

[coderabbitai]

Walkthrough

The changes introduce two GitHub Actions workflows: one for enforcing semantic pull request practices and another for automating semantic versioning and release management. The first workflow validates pull request titles against conventional commit standards, while the second workflow manages the release process based on commit messages, ensuring streamlined version control and release cycles.

Changes

Files	Change Summary
.github/workflows/semantic_pull_request.yml	Added a workflow to enforce semantic pull request title standards using the amannn/action-semantic-pull-request@v5 action.
.github/workflows/semantic_release.yml	Introduced a workflow for automating semantic versioning and release management using cycjimmy/semantic-release-action.

Poem

🐰 In the meadow where code does play,
New workflows hop in, brightening the day.
With titles so clear and releases so fine,
Our project's now ready, it's truly divine!
Hooray for the changes, let’s dance and rejoice,
For in every commit, we now have a voice! 🎉

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0858852 and 4bef58b.

Files selected for processing (2)

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

Additional comments not posted (4)

.github/workflows/semantic_pull_request.yml (1)

1-20: LGTM!

The GitHub Actions workflow configuration for enforcing semantic pull request practices is well-structured and follows best practices. It is triggered on the appropriate pull request events, grants the necessary permissions, and utilizes the correct action to validate the pull request title against conventional commit standards.

This workflow will enhance the consistency and clarity of commit messages, thereby improving the overall quality of the project's version control practices.

.github/workflows/semantic_release.yml (3)

12-13: LGTM!

The "Checkout" step is correctly using the latest version of the actions/checkout action to check out the repository.

---

14-17: LGTM!

The "Configure Semantic Release" step correctly generates a .releaserc.json file with the necessary configuration for non-NPM projects. The configuration includes the required plugins for semantic release to function properly, and the empty branches array is intentional, as the workflow is triggered on pushes to the main branch. The reference to the workaround is helpful for understanding the purpose of this step.

---

18-24: LGTM!

The "Create Release" step correctly uses the latest version of the cycjimmy/semantic-release-action action to execute the release process. The GITHUB_TOKEN secret is correctly used for authentication, allowing the action to create releases on the repository. The branches input is set to ["main"], which is consistent with the workflow trigger.

---

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.

[tuxcanfly]

OK.

[github-actions]

🎉 This PR is included in version 0.7.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀