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:automations #28

Merged
merged 1 commit into from
Sep 10, 2024
Merged

chore:automations #28

merged 1 commit into from
Sep 10, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Sep 10, 2024

Summary by CodeRabbit

  • New Features

    • Introduced automated labeling for pull requests based on conventional release standards.
    • Added a workflow to automate the process of publishing stable releases to PyPI.
    • Implemented a comprehensive release workflow for managing alpha versions and proposing stable releases.
  • Bug Fixes

    • Improved the reliability of accessing the README.md file by using absolute paths.
  • Documentation

    • Updated workflow configurations to enhance clarity and usability.

Copy link

coderabbitai bot commented Sep 10, 2024

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 34 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 2fb562b and 10ce7e7.

Walkthrough

This pull request introduces multiple GitHub Actions workflows to automate the software release process. It includes workflows for adding labels to pull requests based on conventional standards, publishing stable releases to PyPI, and managing the release cycle by publishing alpha versions and proposing stable releases. Additionally, the setup.py file has been modified to enhance the reliability of accessing the README.md file through improved path handling.

Changes

File Change Summary
.github/workflows/conventional-label.yaml, .github/workflows/publish_stable.yml, .github/workflows/release_workflow.yml Added workflows for labeling pull requests, publishing stable releases to PyPI, and managing the release cycle with alpha versions and stable proposals.
setup.py Modified the find_resource_files function to use an absolute path for accessing README.md.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant CI/CD
    participant PyPI

    User->>GitHub: Opens Pull Request
    GitHub->>CI/CD: Trigger Labeling Workflow
    CI/CD->>GitHub: Apply Labels

    User->>GitHub: Merges Pull Request
    GitHub->>CI/CD: Trigger Release Workflow
    CI/CD->>CI/CD: Publish Alpha Version
    CI/CD->>GitHub: Notify Team
    CI/CD->>CI/CD: Build and Publish to PyPI
    CI/CD->>GitHub: Propose Stable Release
Loading

🐰 In the garden, changes bloom,
With workflows that chase away gloom.
Labels and releases, all in a row,
Automate tasks, let the progress flow!
Hops of joy, we celebrate,
A brighter path, it’s never too late! 🌼


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 added the automations and testing automations and workflows, no code changes label Sep 10, 2024
@JarbasAl JarbasAl merged commit 42f64ac into dev Sep 10, 2024
1 of 9 checks passed
@JarbasAl JarbasAl deleted the auto branch September 10, 2024 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automations and testing automations and workflows, no code changes ignore-for-release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant