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

feat: Add merge preview bot #139

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

ankit16-19
Copy link
Collaborator

@ankit16-19 ankit16-19 commented Apr 23, 2024

Description

PR's from collaborators can't run workflows as secrete won't be available to them.
Therefor for testing and running workflow. we found a way see the below comment for more deatils.
#136 (comment)

This pr add bot for making those changes automated. This can be triggered by collaborator or owner.

Regarding dual runs of workflows.
We can disable alpha releases. After review. Workflow can be tested with bee-bot preview runs.

Checklist

  • Documentation Updated
  • sbt scalafmtAll Run (and optionally sbt scalafmtSbt)
  • At least one approval from a codeowner

Summary by CodeRabbit

  • New Features
    • Introduced a "Merge preview" workflow that activates upon new comments on issues, enhancing the preview process for code changes.

Copy link

coderabbitai bot commented Apr 23, 2024

Walkthrough

A new GitHub workflow named "Merge preview" has been introduced. It activates when comments are made on issues, running on Ubuntu 18.04. The workflow checks out the repository and utilizes a specific GitHub token to perform merge previews, enhancing the review process by automatically simulating merges.

Changes

File Path Change Summary
.github/workflows/merge-preview.yml Added a new workflow for automatic merge previews on issue comments.

Poem

🐇✨
In the garden of code, where the bits all play,
A new workflow blooms, oh hip hooray!
On comments it springs, without delay,
Merging previews in a magical ballet.
Cheers to changes, on this bright day! 🎉
🐇💻


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 71365e6 and 7d9560e.
Files selected for processing (1)
  • .github/workflows/merge-preview.yml (1 hunks)
Additional comments not posted (1)
.github/workflows/merge-preview.yml (1)

4-6: The trigger configuration correctly activates the workflow on new issue comments.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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

@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

Out of diff range and nitpick comments (2)
.github/workflows/merge-preview.yml (2)

10-10: Consider updating the runner to Ubuntu 20.04 for enhanced features and extended support.


13-13: Consider pinning nwtgck/actions-merge-preview to a stable release version instead of the 'develop' branch to ensure stability.

@ankit16-19
Copy link
Collaborator Author

@bee-bot merge preview

@ankit16-19
Copy link
Collaborator Author

ankit16-19 commented Apr 23, 2024

@nylonee it seems like this needs to be merged, before the bot can start working. Please review the changes.
This is the parent repo:
https://github.com/nwtgck/actions-merge-preview/tree/develop

@nylonee nylonee merged commit a7e1dcc into nylonee:main Apr 23, 2024
1 of 2 checks passed
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.

2 participants