Discord GFI webhook

[pettinarip]

Description

Simpler alternative to #12436 using the GH webhooks service. Whenever an issue changed, the new api route /api/gfi-issues-webhook is going to be called.

Summary by CodeRabbit

• New Features
  • Added a feature to convert GitHub issue labels to human-readable text.
  • Introduced a webhook handler for notifying a Discord channel when a new "good first issue" is labeled on GitHub.

[coderabbitai]

Walkthrough

The recent update introduces a new utility function for converting GitHub labels into text, alongside a webhook handler for Next.js. This handler is designed to monitor GitHub issues labeled as "good first issue" and, when such an issue is unassigned, automatically sends a notification to a specified Discord channel. This enhancement aims to streamline the process of identifying and communicating new, beginner-friendly issues to potential contributors.

Changes

File	Change Summary
src/lib/utils/gh.ts	Added rawLabelsToText function to convert labels to text using predefined mappings.
src/pages/api/.../gfi-issues-webhook.ts	Introduced a webhook handler for notifying a Discord channel about unassigned "good first issue" labels.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[netlify]

✅ Deploy Preview for ethereumorg ready!

Name	Link
🔨 Latest commit	d09ba0d
🔍 Latest deploy log	https://app.netlify.com/sites/ethereumorg/deploys/65fd9d0d90aed60009b7011b
😎 Deploy Preview	https://deploy-preview-12500--ethereumorg.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f920ff1 and 0c75306.

Files selected for processing (2)

• src/lib/utils/gh.ts (1 hunks)
• src/pages/api/gfi-issues-webhook.ts (1 hunks)

Additional comments: 2

src/pages/api/gfi-issues-webhook.ts (2)

• 17-18: Ensure that the API correctly handles other HTTP methods by returning a 405 status code. This is a good practice for API design.
• 68-71: Proper error handling is implemented for the case where the Discord webhook response is not OK. Logging the error is a good practice, but consider also implementing a mechanism to alert the maintainers or retry the operation, as this could be a critical failure point in the notification system.

[wackerow]

@pettinarip Am I correct that this isn't implemented anywhere yet?

[pettinarip]

Hmm not sure if I follow you on this. Inside our project? this api doesn't exist nor the logic itself does.

[pettinarip]

Maybe you are confused with the similar logic in #12436. I'm sorry about that, we have decided to go with this implementation for now. I have closed the other one.