Feat: Trigger review-app workflow when '/deploy-review-app' is commented (basic implementation)

[rameziophobia]

A better implementation is added in #597
To test comment triggers, the event trigger should be on master in this workflow file first. This change should enable testing the changes in #597

source: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#issue_comment

Note: This event will only trigger a workflow run if the workflow file is on the default branch.

---

This change is 

Summary by CodeRabbit

• New Features
  • Enhanced deployment workflow to respond to issue comments, allowing users to trigger deployments with specific commands.
  • Improved control flow for staging deployments, ensuring they are only initiated under defined conditions for better efficiency.

[coderabbitai]

Walkthrough

The changes modify the GitHub Actions workflow for deploying a review app to the Control Plane. A new trigger is added for issue_comment events, allowing deployments to be initiated by specific comments. Additionally, a conditional statement is introduced to control when the deployment job executes, ensuring it only runs under defined circumstances.

Changes

File Path	Change Summary
.github/workflows/deploy-to-control-plane-review.yml	Added a trigger for issue_comment events and updated conditions for the deploy-to-control-plane-staging job to refine execution criteria.

Poem

In a meadow bright and fair,
A rabbit hops without a care.
With comments made, the app takes flight,
Deploying dreams, oh what a sight!
In workflows we find our way,
A dance of code, come join the play! 🐇✨

---

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

[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 dccf95f and 3eeca94.

Files selected for processing (1)

• .github/workflows/deploy-to-control-plane-review.yml (2 hunks)

Additional comments not posted (2)

.github/workflows/deploy-to-control-plane-review.yml (2)

9-10: Added trigger for issue comments.

The workflow now triggers on issue_comment events, specifically for created and edited comments. This allows the workflow to respond to user interactions via comments.

The code changes are approved.

---

19-19: Conditional execution for deploy-to-control-plane-staging job.

The job now includes a condition to check if the event is not an issue_comment or if the comment matches /deploy-review-app and is associated with a pull request. This ensures that the deployment is only triggered under the defined circumstances.

The code changes are approved.