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

semver #33

Merged
merged 1 commit into from
Sep 11, 2024
Merged

semver #33

merged 1 commit into from
Sep 11, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Sep 11, 2024

Summary by CodeRabbit

  • New Features

    • Introduced automated labeling for pull requests to enhance organization and tracking.
    • Added automated workflows for publishing stable releases and alpha versions, improving release management.
    • Implemented notifications for team members upon merging pull requests.
  • Bug Fixes

    • Updated dependency version specifications to ensure compatibility and prevent breaking changes.
  • Chores

    • Enhanced the GitHub Actions workflows for better automation and efficiency in the development lifecycle.

Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce three new GitHub Actions workflows for automating pull request labeling, stable releases, and alpha version publishing. The workflows enhance the management of pull requests and releases by automatically applying labels based on content, publishing stable versions from the master branch, and notifying team members upon merging. Additionally, the requirements.txt file has been updated to specify version constraints for several dependencies, ensuring compatibility while avoiding potential breaking changes in future releases.

Changes

Files Change Summary
.github/workflows/conventional-label.yml New workflow to automatically label pull requests based on content.
.github/workflows/publish_stable.yml New workflow for automating stable releases, including publishing to Test PyPI and syncing branches.
.github/workflows/release_workflow.yml New workflow for managing alpha releases and notifying team members upon pull request merges.
requirements.txt Updated version specifications for ovos_plugin_manager, ovos-utils, and ovos-bus-client.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Workflow
    participant TestPyPI
    participant Matrix

    User->>GitHub: Open or Edit PR
    GitHub->>Workflow: Trigger conventional-label.yml
    Workflow->>GitHub: Apply labels

    User->>GitHub: Push to master
    GitHub->>Workflow: Trigger publish_stable.yml
    Workflow->>TestPyPI: Publish stable version
    Workflow->>GitHub: Sync dev branch

    User->>GitHub: Merge PR
    GitHub->>Workflow: Trigger release_workflow.yml
    Workflow->>Matrix: Notify of merge
    Workflow->>TestPyPI: Publish alpha version
    Workflow->>GitHub: Propose stable release
Loading

🐇 In the garden, changes bloom bright,
New workflows hop, taking flight.
Labels and releases, all in a row,
A joyful dance, watch progress grow!
With dependencies set, we leap with glee,
A brighter future, for you and me! 🌼


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

@JarbasAl JarbasAl merged commit ea884dd into dev Sep 11, 2024
3 of 6 checks passed
@JarbasAl JarbasAl deleted the semver branch September 11, 2024 04:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant