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

Require comment trigger for Review Apps #628

Merged
merged 1 commit into from
Mar 19, 2025
Merged

Conversation

Judahmeek
Copy link
Collaborator

@Judahmeek Judahmeek commented Mar 19, 2025

This change is Reviewable

Summary by CodeRabbit

  • Chores
    • Streamlined automation triggers to require explicit actions for process execution, providing improved control over automated activities.

Copy link

coderabbitai bot commented Mar 19, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies a GitHub Actions workflow file by removing the automatic triggers for the push and pull_request events on the master branch. The workflow now only triggers on issue_comment events and via manual invocation using workflow_dispatch. The overall control flow remains intact, with only the conditions under which the workflow is executed being narrowed.

Changes

File(s) Changes Summary
.github/workflows/...review-app.yml Removed push and pull_request triggers for the master branch; retained issue_comment and workflow_dispatch triggers for manual start.

Sequence Diagram(s)

sequenceDiagram
    participant User as GitHub User
    participant GitHub as GitHub Actions
    participant Workflow as Review App Workflow

    Note over GitHub: Only specific triggers are active
    User->>GitHub: Push event to master (ignored)
    User->>GitHub: Pull Request to master (ignored)
    User->>GitHub: Issue comment "deploy"
    GitHub->>Workflow: Trigger via issue_comment event
    User->>GitHub: Manual trigger (workflow_dispatch)
    GitHub->>Workflow: Execute workflow
Loading

Poem

I’m a rabbit with a joyful leap,
Removed the triggers that made us weep.
No auto-push, no PR fray,
Now manual hops lead the way.
With each comment, our workflow sings,
Happy code and distant spring.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 15691e7 and 69fb674.

📒 Files selected for processing (1)
  • .github/workflows/deploy-to-control-plane-review-app.yml (0 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

Copy link

🚀 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 instructions, environment setup, and configuration options.


Copy link

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.

@Judahmeek Judahmeek merged commit d6fdfd8 into master Mar 19, 2025
6 checks passed
@Judahmeek Judahmeek deleted the judahmeek/restrict branch March 19, 2025 20:45
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