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

[FEATURE]: Nightly clean review apps and images #603

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

rameziophobia
Copy link
Contributor

@rameziophobia rameziophobia commented Aug 26, 2024

Note: NOT TESTED YET

This change is Reviewable

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration parameter to manage stale application images, triggering nightly cleanup processes.
    • Added a GitHub Action for setting up a Ruby environment tailored for the Control Plane CLI and cpflow gem.
    • Launched a nightly workflow to automate the removal of stale review applications and associated images.
  • Improvements

    • Streamlined the deployment workflow by consolidating Ruby setup and Control Plane CLI installation into a single step.

Copy link

coderabbitai bot commented Aug 26, 2024

Warning

Rate limit exceeded

@rameziophobia has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 17 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 6069e93 and b2008f8.

Walkthrough

The changes introduce a new configuration parameter for managing stale application deployments, implement a GitHub Action for setting up a Ruby environment, streamline a deployment workflow by consolidating setup steps, and create a new workflow for nightly cleanup of stale review applications and images. These alterations aim to enhance automation and maintenance within the project.

Changes

File Path Change Summary
.controlplane/controlplane.yml Added new parameter stale_app_image_deployed_days: 5 for managing stale applications.
.github/actions/common-ruby-cpl-setup/action.yml Introduced a new GitHub Action to set up a Ruby environment, install Control Plane CLI, and cpflow gem.
.github/actions/deploy-to-control-plane/action.yml Modified workflow to replace multiple setup steps with a single "Setup Environment" step.
.github/workflows/nightly-remove-stale-review-apps.yml Created a new workflow for nightly cleanup of stale review applications and images.

Sequence Diagram(s)

sequenceDiagram
    participant Scheduler
    participant GitHub Action
    participant Repository
    participant Cleanup Script

    Scheduler->>GitHub Action: Trigger nightly cleanup
    GitHub Action->>Repository: Checkout latest code
    GitHub Action->>Cleanup Script: Execute cleanup for review apps
    Cleanup Script-->>GitHub Action: Confirm review apps cleaned
    GitHub Action->>Cleanup Script: Execute cleanup for images
    Cleanup Script-->>GitHub Action: Confirm images cleaned
    GitHub Action-->>Scheduler: Cleanup complete
Loading

Poem

🐇 In the garden of code, changes bloom bright,
Stale apps take flight, into the night!
With Ruby now set, and actions in line,
Automation hops, making work fine.
Clean up the mess, let the fresh shine through,
A joyful dance, for the rabbit and crew! 🌼


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

Hi 👋 To deploy a review app, please comment /deploy-review-app

@rameziophobia
Copy link
Contributor Author

/deploy-review-app

Copy link

We started working on your review-app deployment. You can track progress in the Actions Tab here on Github.

@rameziophobia
Copy link
Contributor Author

/deploy-review-app

Copy link

We started working on your review-app deployment. You can track progress in the Actions Tab here on Github.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d8b1e93 and 6069e93.

Files selected for processing (4)
  • .controlplane/controlplane.yml (1 hunks)
  • .github/actions/common-ruby-cpl-setup/action.yml (1 hunks)
  • .github/actions/deploy-to-control-plane/action.yml (1 hunks)
  • .github/workflows/nightly-remove-stale-review-apps.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .controlplane/controlplane.yml
Additional comments not posted (7)
.github/workflows/nightly-remove-stale-review-apps.yml (3)

1-5: LGTM!

The file header and schedule section are correctly defined.

The code changes are approved.


7-9: LGTM!

The jobs section is correctly defined.

The code changes are approved.


11-24: LGTM!

The steps section is correctly defined and uses appropriate actions and commands.

The code changes are approved.

.github/actions/common-ruby-cpl-setup/action.yml (3)

1-5: LGTM!

The file header and description section are clear and descriptive.

The code changes are approved.


6-8: LGTM!

The runs section is correctly defined.

The code changes are approved.


9-25: LGTM!

The steps section is correctly defined and uses appropriate actions and commands.

The code changes are approved.

.github/actions/deploy-to-control-plane/action.yml (1)

19-20: LGTM!

The consolidation of setup steps into a single step improves maintainability and reduces redundancy.

The code changes are approved.

@rameziophobia rameziophobia marked this pull request as draft August 27, 2024 06:11
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