More work on github actions #621

justin808 · 2025-01-28T04:42:19Z

This change is

Summary by CodeRabbit

New Features
- Added a new GitHub Action for displaying help commands in pull request comments
- Introduced a streamlined help command workflow
Chores
- Simplified action references across multiple workflow files by removing specific branch tags
- Updated help message text for improved clarity and specificity
Refactor
- Restructured help command implementation to use a dedicated custom action
- Standardized action references in deployment and environment setup workflows

coderabbitai · 2025-01-28T04:42:26Z

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a new GitHub Action for displaying help commands and updates several workflow files by removing specific branch references from action calls. The primary focus is on simplifying action references across multiple workflow files, such as delete-review-app.yml, deploy-to-control-plane-staging.yml, and others. A new "Show Help Command" action has been added to provide detailed instructions for deployment-related commands like /deploy and /destroy.

Changes

File	Change Summary
`.github/actions/help-command/action.yml`	New GitHub Action added for displaying help information in pull request comments
`.github/workflows/*`	Removed specific branch tags (`@justin808-working-for-deploys`) from action references in multiple workflow files
`.github/workflows/help-command.yml`	Replaced inline script with new custom help command action
`.github/workflows/review-app-help.yml`	Updated help message text for more detailed instructions

Sequence Diagram

sequenceDiagram
    participant User
    participant GitHub
    participant HelpAction
    participant PRComment

    User->>GitHub: Trigger help command
    GitHub->>HelpAction: Invoke help action
    HelpAction->>PRComment: Generate help text
    HelpAction->>PRComment: Post comment with instructions
    PRComment-->>User: Display deployment help

Possibly related PRs

Improvements to deployments #615: Introduces deployment commands related to help functionality
delete-on-pr-close #617: Includes review app deployment commands
Github actions fixes #618: Covers deploying and destroying review apps

Poem

🐰 A rabbit's guide to GitHub's grace,
Helping commands find their place!
With actions clean and workflows bright,
We simplify deployment's might
Hop, hop, hooray for code's delight! 🚀

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 098b886 and be2b0d9.

📒 Files selected for processing (8)

.github/actions/help-command/action.yml (1 hunks)
.github/workflows/delete-review-app.yml (2 hunks)
.github/workflows/deploy-to-control-plane-staging.yml (1 hunks)
.github/workflows/deploy-to-control-plane.yml (3 hunks)
.github/workflows/help-command.yml (1 hunks)
.github/workflows/nightly-remove-stale-review-apps.yml (1 hunks)
.github/workflows/promote-staging-to-production.yml (1 hunks)
.github/workflows/review-app-help.yml (1 hunks)

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 generate docstrings to generate docstrings for this PR. (Beta)
@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 · 2025-01-28T04:42:29Z

Hi 👋 Here are the commands available for this PR:

/deploy-review-app: Deploy your changes to a review environment
/delete-review-app: Clean up the review environment when you're done
/help: Show detailed information about all commands

Use /help to see full documentation, including configuration options.

github-actions · 2025-01-28T04:42:30Z

🚀 Quick Review App Commands

Welcome! Here are the commands you can use in this PR:

`/deploy-review-app`

Deploy your PR branch for testing

`/delete-review-app`

Remove the review app when done

`/help`

Show detailed documentation

Note: Type /help for detailed instructions, environment setup, and configuration options.

justin808 · 2025-01-28T04:43:58Z

/help

github-actions · 2025-01-28T04:44:09Z

📚 Detailed Review App Commands Guide

This is a detailed guide to using review app commands. For a quick reference, see the message posted when your PR was created.

Available Commands

`/deploy-review-app`

Deploys your PR branch to a review environment on Control Plane.

Creates a new review app if one doesn't exist
Updates the existing review app if it already exists
Provides a unique URL to preview your changes
Shows build and deployment progress in real-time

Required Environment Secrets:

CPLN_TOKEN_STAGING: Control Plane authentication token
CPLN_TOKEN_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables:

CPLN_ORG_STAGING: Control Plane authentication token
CPLN_ORG_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables (these need to match your control_plane.yml file:

PRODUCTION_APP_NAME: Control Plane production app name
STAGING_APP_NAME: Control Plane staging app name
REVIEW_APP_PREFIX: Control Plane review app prefix

Optional Configuration:

WAIT_TIMEOUT: Deployment timeout in seconds (default: 900)
- Must be a positive integer
- Can be set in GitHub Actions variables
- Applies to both deployment and workload readiness checks

`/delete-review-app`

Deletes the review app associated with this PR.

Removes all resources from Control Plane
Helpful for cleaning up when you're done testing
Can be re-deployed later using /deploy-review-app

Required Environment Variables:

CPLN_TOKEN: Control Plane authentication token
CPLN_ORG: Control Plane organization name

`/help`

Shows this detailed help message.

Environment Setup

Set required secrets in your repository settings:
- CPLN_TOKEN
- CPLN_ORG
Optional: Configure WAIT_TIMEOUT in GitHub Actions variables to customize deployment timeout

Control Plane Integration

Review apps are deployed to Control Plane with the following configuration:

App Name Format: qa-react-webpack-rails-tutorial-pr-{PR_NUMBER}
Console URL: https://console.cpln.io/console/org/{CPLN_ORG}/gvc/{APP_NAME}/-info

Automatic Cleanup

Review apps are automatically deleted when:

The PR is closed (merged or not merged)
The PR is stale (via nightly cleanup job)

For more information, see the React on Rails Tutorial documentation

justin808 · 2025-01-28T04:48:00Z

/help

github-actions · 2025-01-28T04:48:10Z

📚 Detailed Review App Commands Guide

This is a detailed guide to using review app commands. For a quick reference, see the message posted when your PR was created.

Available Commands

`/deploy-review-app`

Deploys your PR branch to a review environment on Control Plane.

Creates a new review app if one doesn't exist
Updates the existing review app if it already exists
Provides a unique URL to preview your changes
Shows build and deployment progress in real-time

Required Environment Secrets:

CPLN_TOKEN_STAGING: Control Plane authentication token
CPLN_TOKEN_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables:

CPLN_ORG_STAGING: Control Plane authentication token
CPLN_ORG_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables (these need to match your control_plane.yml file:

PRODUCTION_APP_NAME: Control Plane production app name
STAGING_APP_NAME: Control Plane staging app name
REVIEW_APP_PREFIX: Control Plane review app prefix

Optional Configuration:

WAIT_TIMEOUT: Deployment timeout in seconds (default: 900)
- Must be a positive integer
- Can be set in GitHub Actions variables
- Applies to both deployment and workload readiness checks

`/delete-review-app`

Deletes the review app associated with this PR.

Removes all resources from Control Plane
Helpful for cleaning up when you're done testing
Can be re-deployed later using /deploy-review-app

Required Environment Variables:

CPLN_TOKEN: Control Plane authentication token
CPLN_ORG: Control Plane organization name

`/help`

Shows this detailed help message.

Environment Setup

Set required secrets in your repository settings:
- CPLN_TOKEN
- CPLN_ORG
Optional: Configure WAIT_TIMEOUT in GitHub Actions variables to customize deployment timeout

Control Plane Integration

Review apps are deployed to Control Plane with the following configuration:

App Name Format: qa-react-webpack-rails-tutorial-pr-{PR_NUMBER}
Console URL: https://console.cpln.io/console/org/{CPLN_ORG}/gvc/{APP_NAME}/-info

Automatic Cleanup

Review apps are automatically deleted when:

The PR is closed (merged or not merged)
The PR is stale (via nightly cleanup job)

For more information, see the React on Rails Tutorial documentation

justin808 · 2025-01-28T04:59:30Z

/help

github-actions · 2025-01-28T04:59:42Z

📚 Detailed Review App Commands Guide

This is a detailed guide to using review app commands. For a quick reference, see the message posted when your PR was created.

Available Commands

`/deploy-review-app`

Deploys your PR branch to a review environment on Control Plane.

Creates a new review app if one doesn't exist
Updates the existing review app if it already exists
Provides a unique URL to preview your changes
Shows build and deployment progress in real-time

Required Environment Secrets:

CPLN_TOKEN_STAGING: Control Plane authentication token
CPLN_TOKEN_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables:

CPLN_ORG_STAGING: Control Plane authentication token
CPLN_ORG_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables (these need to match your control_plane.yml file:

PRODUCTION_APP_NAME: Control Plane production app name
STAGING_APP_NAME: Control Plane staging app name
REVIEW_APP_PREFIX: Control Plane review app prefix

Optional Configuration:

WAIT_TIMEOUT: Deployment timeout in seconds (default: 900)
- Must be a positive integer
- Can be set in GitHub Actions variables
- Applies to both deployment and workload readiness checks

`/delete-review-app`

Deletes the review app associated with this PR.

Removes all resources from Control Plane
Helpful for cleaning up when you're done testing
Can be re-deployed later using /deploy-review-app

Required Environment Variables:

CPLN_TOKEN: Control Plane authentication token
CPLN_ORG: Control Plane organization name

`/help`

Shows this detailed help message.

Environment Setup

Set required secrets in your repository settings:
- CPLN_TOKEN
- CPLN_ORG
Optional: Configure WAIT_TIMEOUT in GitHub Actions variables to customize deployment timeout

Control Plane Integration

Review apps are deployed to Control Plane with the following configuration:

App Name Format: qa-react-webpack-rails-tutorial-pr-{PR_NUMBER}
Console URL: https://console.cpln.io/console/org/{CPLN_ORG}/gvc/{APP_NAME}/-info

Automatic Cleanup

Review apps are automatically deleted when:

The PR is closed (merged or not merged)
The PR is stale (via nightly cleanup job)

For more information, see the React on Rails Tutorial documentation

github-actions · 2025-01-28T05:17:46Z

✅ Deployment complete for PR #621, commit be2b0d9

🚀 Review App for PR #621
🎮 Control Plane Console

📋 View Completed Action Build and Deploy Logs

justin808 · 2025-01-28T05:17:55Z

/help

github-actions · 2025-01-28T05:18:06Z

📚 Detailed Review App Commands Guide

This is a detailed guide to using review app commands. For a quick reference, see the message posted when your PR was created.

Available Commands

`/deploy-review-app`

Deploys your PR branch to a review environment on Control Plane.

Creates a new review app if one doesn't exist
Updates the existing review app if it already exists
Provides a unique URL to preview your changes
Shows build and deployment progress in real-time

Required Environment Secrets:

CPLN_TOKEN_STAGING: Control Plane authentication token
CPLN_TOKEN_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables:

CPLN_ORG_STAGING: Control Plane authentication token
CPLN_ORG_PRODUCTION: Control Plane authentication token

Required GitHub Actions Variables (these need to match your control_plane.yml file:

PRODUCTION_APP_NAME: Control Plane production app name
STAGING_APP_NAME: Control Plane staging app name
REVIEW_APP_PREFIX: Control Plane review app prefix

Optional Configuration:

WAIT_TIMEOUT: Deployment timeout in seconds (default: 900)
- Must be a positive integer
- Can be set in GitHub Actions variables
- Applies to both deployment and workload readiness checks

`/delete-review-app`

Deletes the review app associated with this PR.

Removes all resources from Control Plane
Helpful for cleaning up when you're done testing
Can be re-deployed later using /deploy-review-app

Required Environment Variables:

CPLN_TOKEN: Control Plane authentication token
CPLN_ORG: Control Plane organization name

`/help`

Shows this detailed help message.

Environment Setup

Set required secrets in your repository settings:
- CPLN_TOKEN
- CPLN_ORG
Optional: Configure WAIT_TIMEOUT in GitHub Actions variables to customize deployment timeout

Control Plane Integration

Review apps are deployed to Control Plane with the following configuration:

App Name Format: qa-react-webpack-rails-tutorial-pr-{PR_NUMBER}
Console URL: https://console.cpln.io/console/org/{CPLN_ORG}/gvc/{APP_NAME}/-info

Automatic Cleanup

Review apps are automatically deleted when:

The PR is closed (merged or not merged)
The PR is stale (via nightly cleanup job)

For more information, see the React on Rails Tutorial documentation

Updated help

ce0b7dd

update to current branch for uses

0536f3b

remove branch refs

be2b0d9

justin808 merged commit 6add086 into master Jan 28, 2025
4 checks passed

justin808 deleted the justin808-more-work-on-review-apps-1 branch January 28, 2025 05:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More work on github actions #621

More work on github actions #621

justin808 commented Jan 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 28, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025 •

edited

Loading

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

More work on github actions #621

More work on github actions #621

Conversation

justin808 commented Jan 28, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 28, 2025 • edited Loading

Review failed

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

🚀 Quick Review App Commands

/deploy-review-app

/delete-review-app

/help

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

📚 Detailed Review App Commands Guide

Available Commands

/deploy-review-app

/delete-review-app

/help

Environment Setup

Control Plane Integration

Automatic Cleanup

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

📚 Detailed Review App Commands Guide

Available Commands

/deploy-review-app

/delete-review-app

/help

Environment Setup

Control Plane Integration

Automatic Cleanup

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

📚 Detailed Review App Commands Guide

Available Commands

/deploy-review-app

/delete-review-app

/help

Environment Setup

Control Plane Integration

Automatic Cleanup

github-actions bot commented Jan 28, 2025 • edited Loading

justin808 commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

📚 Detailed Review App Commands Guide

Available Commands

/deploy-review-app

/delete-review-app

/help

Environment Setup

Control Plane Integration

Automatic Cleanup

justin808 commented Jan 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

`/deploy-review-app`

`/delete-review-app`

`/help`

`/deploy-review-app`

`/delete-review-app`

`/help`

`/deploy-review-app`

`/delete-review-app`

`/help`

`/deploy-review-app`

`/delete-review-app`

`/help`

github-actions bot commented Jan 28, 2025 •

edited

Loading

`/deploy-review-app`

`/delete-review-app`

`/help`