[FEATURE]: Nightly clean review apps and images

[rameziophobia]

Note: NOT TESTED YET

This change is 

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced new configuration parameters for managing image retention and stale application cleanup.
  • Added a GitHub Action for automating the setup of a Ruby environment with Control Plane CLI and cpflow gem.
  • Launched a nightly workflow to automatically remove stale review applications and associated images.

• Improvements

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce new configuration parameters for image retention and stale application management in the .controlplane/controlplane.yml file. A new GitHub Action named "Setup Environment" is added to automate the setup of a Ruby environment, including the installation of the Control Plane CLI and the cpflow gem. Additionally, a new workflow file is created to automate the nightly cleanup of stale review applications and associated images, enhancing overall project maintenance and automation.

Changes

File Path	Change Summary
.controlplane/controlplane.yml	Added image_retention_days: 5 and stale_app_image_deployed_days: 5 for qa-react-webpack-rails-tutorial.
.github/actions/setup-environment/action.yml	Introduced a new GitHub Action named "Setup Environment" to set up Ruby and install necessary tools.
.github/workflows/nightly-remove-stale-review-apps.yml	Created a new workflow for nightly cleanup of stale review applications and images.

Possibly related PRs

• Rename cpl to cpflow #595: Updates the .controlplane/controlplane.yml file, related to the configuration of the qa-react-webpack-rails-tutorial app.
• Test GitHub triggering review app deployments #597: Modifies the .controlplane/controlplane.yml file, adding configuration options that may interact with image retention settings.
• Feat: Trigger review-app workflow when '/deploy-review-app' is commented (basic implementation) #599: Enhances the workflow for deploying review apps, potentially utilizing the new image retention settings.
• Review App workflow improvements, controlplane app.yml fixes #601: Changes to the .github/workflows/deploy-to-control-plane-review.yml, relevant for managing review app deployments with the new configurations.

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

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

[github-actions]

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

[rameziophobia]

/deploy-review-app

[github-actions]

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

[rameziophobia]

/deploy-review-app

[github-actions]

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

[coderabbitai]

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.

[justin808]

@rameziophobia thanks. looks good.