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: Added the feature to auto comment on pr merged #343

Merged

Conversation

suhanipaliwal
Copy link
Contributor

@suhanipaliwal suhanipaliwal commented May 28, 2024

Related Issue

Fixes #332

Description

I have added auto-comment-on-pr-merge.yml in .github/workflows directory. This file will add the feature of auto commenting when a pr is merged.

Summary by CodeRabbit

  • New Features
    • Introduced an automated celebratory comment on merged pull requests to thank contributors for their contributions.

Copy link

vercel bot commented May 28, 2024

@suhanipaliwal is attempting to deploy a commit to the Sanchit Bajaj's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented May 28, 2024

Walkthrough

The new file .github/workflows/auto-comment-pr-merge.yml adds a GitHub Actions workflow designed to automatically post a celebratory comment on a merged pull request. This feature ensures timely acknowledgment of contributions and reduces the administrative burden on maintainers by automating the commenting process.

Changes

Files Change Summary
.github/workflows/auto-comment-pr-merge.yml Introduced a new GitHub Actions workflow to automatically comment on merged pull requests.

Sequence Diagram(s) (Beta)

sequenceDiagram
    actor Contributor
    participant GitHub
    participant Workflow

    Contributor->>GitHub: Merge Pull Request
    GitHub->>Workflow: Trigger Workflow
    Workflow->>GitHub: Post celebratory comment on PR
Loading

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Automate commenting on merged PRs (#332)

Possibly related issues


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.
    • @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 full the 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 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.

@github-actions github-actions bot added the title needs formatting Title of issue or pull request does not match the guidelines label May 28, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job, @suhanipaliwal! 🎉 Thank you for submitting your pull request. Your contribution is valuable and we appreciate your efforts to improve our project. Keep being the part of the community!

'We will promptly review your changes and offer feedback. Keep up the excellent work!
Kindly remember to check our Contributing Guidelines'

Copy link
Contributor

@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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 116d947 and ff1d7d1.
Files selected for processing (1)
  • .github/workflows/auto-comment-pr-merge.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/auto-comment-pr-merge.yml

@Sanchitbajaj02 Sanchitbajaj02 changed the title Added the feature to auto comment on pr merged feat: Added the feature to auto comment on pr merged May 29, 2024
@github-actions github-actions bot removed the title needs formatting Title of issue or pull request does not match the guidelines label May 29, 2024
@Sanchitbajaj02 Sanchitbajaj02 added 🏆 good first issue Good for newcomers ⭐ enhancement Feature enhancement ✨ goal: improve interface EASY Difficulty Level: Easy level1 10 points gssoc GSSOC'24 Required Label labels May 29, 2024
@Sanchitbajaj02 Sanchitbajaj02 merged commit 1de2326 into Sanchitbajaj02:master May 29, 2024
10 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EASY Difficulty Level: Easy ⭐ enhancement Feature enhancement ✨ goal: improve interface 🏆 good first issue Good for newcomers gssoc GSSOC'24 Required Label level1 10 points
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto Commenting when a PR is merged
2 participants