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

chore(ci): add semantic release #9

Merged
merged 1 commit into from
Sep 26, 2024
Merged

chore(ci): add semantic release #9

merged 1 commit into from
Sep 26, 2024

Conversation

MSevey
Copy link
Collaborator

@MSevey MSevey commented Sep 25, 2024

Overview

Summary by CodeRabbit

  • New Features
    • Introduced a new GitHub Actions workflow for semantic pull requests to enhance pull request management.
    • Added a GitHub Actions workflow for automated releases based on semantic versioning principles.

These updates streamline the development process, ensuring smoother pull request handling and automated release management.

Copy link

coderabbitai bot commented Sep 25, 2024

Caution

Review failed

The pull request is closed.

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 pull request events and includes a job that utilizes the amannn/action-semantic-pull-request@v5 action. The semantic_release.yml workflow is triggered on pushes to the main branch and automates the release process using several actions to check out the code, configure semantic release, and create a release.

Changes

File Path Change Summary
.github/workflows/semantic_pull_request.yml New workflow added for handling semantic pull requests, triggered on pull request events.
.github/workflows/semantic_release.yml New workflow added for automating releases on pushes to the main branch, including steps for checkout and release creation.

Poem

🐰 In the meadow where the code does play,
New workflows hop in, brightening the day.
Pull requests dance with semantic grace,
Releases bloom, a joyful embrace.
With every commit, we leap and cheer,
For a smoother path, our goals are clear! 🌼


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

@RollkitBot RollkitBot requested review from a team and removed request for a team September 25, 2024 15:22
@MSevey MSevey enabled auto-merge (squash) September 25, 2024 15:52
@MSevey MSevey merged commit 0098194 into main Sep 26, 2024
17 checks passed
@MSevey MSevey deleted the semantic-release branch September 26, 2024 19:07
Copy link

github-actions bot commented Oct 2, 2024

🎉 This PR is included in version 0.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants