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 workflow as per issue #342 #346

Merged
merged 2 commits into from
May 30, 2024

Conversation

Asymtode712
Copy link
Contributor

@Asymtode712 Asymtode712 commented May 30, 2024

Related Issue

fixes: #342

Description

This feature aims to solve the problem of poor communication and lack of acknowledgment when issues are closed. By automatically commenting on closed issues, it ensures that contributors are informed about the closure and are thanked for their efforts. This helps maintain a positive and engaging community atmosphere, encouraging continued contributions and fostering good relationships between maintainers and contributors.

Summary by CodeRabbit

  • Chores
    • Introduced a GitHub Actions workflow to automatically close linked issues when a pull request is merged.

Copy link

vercel bot commented May 30, 2024

@Asymtode712 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 30, 2024

Walkthrough

The new close-on-merge.yml workflow file introduces automation to close linked issues when a pull request (PR) is merged. It extracts issue numbers from the PR body, closes each linked issue, and adds a comment to inform contributors about the closure, enhancing communication and acknowledgment within the project.

Changes

Files/Paths Change Summary
.github/workflows/close-on-merge.yml Created a new GitHub Actions workflow to automatically close linked issues and comment on their closure when a PR is merged.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Developer as Developer
    participant GitHub as GitHub
    participant Workflow as close-on-merge.yml
    participant Issue as GitHub Issue

    Developer->>GitHub: Merge Pull Request
    GitHub->>Workflow: Trigger close-on-merge.yml
    Workflow->>GitHub: Extract linked issue numbers from PR body
    Workflow->>Issue: Close linked issues
    Workflow->>Issue: Add comment indicating closure by PR
Loading

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Auto Commenting when an Issue is Closed (#342)
Inform contributors about issue closure (#342)
Acknowledge contributors' efforts (#342)

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 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 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 30, 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, @Asymtode712! 🎉 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 3208098 and 44011e4.

Files selected for processing (1)
  • .github/workflows/close-on-merge.yml (1 hunks)
Additional comments not posted (1)
.github/workflows/close-on-merge.yml (1)

1-30: Ensure the workflow meets the PR objectives and follows best practices.

The workflow is well-structured and aligns with the PR objectives to automatically comment on and close issues when a PR is merged. It uses standard GitHub Actions features and follows best practices for workflow design.

@Asymtode712 Asymtode712 changed the title added workflow as per issue #342 feat: added workflow as per issue #342 May 30, 2024
@github-actions github-actions bot removed the title needs formatting Title of issue or pull request does not match the guidelines label May 30, 2024
@Asymtode712
Copy link
Contributor Author

@Sanchitbajaj02 please review and merge this PR

Also, please add labels and assign me this PR

@Sanchitbajaj02 Sanchitbajaj02 added ⭐ enhancement Feature enhancement dependencies Pull requests that update a dependency file EASY Difficulty Level: Easy level1 10 points gssoc GSSOC'24 Required Label labels May 30, 2024
@github-actions github-actions bot removed the gssoc GSSOC'24 Required Label label May 30, 2024
@Sanchitbajaj02 Sanchitbajaj02 merged commit 7e7f538 into Sanchitbajaj02:master May 30, 2024
3 of 4 checks passed
@Asymtode712
Copy link
Contributor Author

@Sanchitbajaj02 please add 'gssoc' label it was removed by the bot

@Sanchitbajaj02 Sanchitbajaj02 added the gssoc GSSOC'24 Required Label label May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file EASY Difficulty Level: Easy ⭐ enhancement Feature enhancement gssoc GSSOC'24 Required Label level1 10 points
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feat: Auto Commenting when an Issue is Closed
2 participants