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

added non-core-qn workflow #8889

Merged
merged 18 commits into from
Nov 12, 2024
Merged

added non-core-qn workflow #8889

merged 18 commits into from
Nov 12, 2024

Conversation

tellmeY18
Copy link
Member

@tellmeY18 tellmeY18 commented Oct 23, 2024

Proposed Changes

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • New Features
    • Introduced an automated notification system for the core team when non-core contributors post questions in issue comments.
    • The system labels relevant issues and sends notifications to the core team via Slack, enhancing communication and response efficiency.

@tellmeY18 tellmeY18 requested a review from a team as a code owner October 23, 2024 05:12
Copy link

netlify bot commented Oct 23, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 9a49d8e
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67338d173abb8400088cf179
😎 Deploy Preview https://deploy-preview-8889--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

const isOrgMember = orgMembers.some(member => member.login === commenter);
if (!isOrgMember) {
const commentBody = context.payload.comment.body.toLowerCase();
const questionKeywords = ["?", "what", "how", "why", "when", "who"];
Copy link
Member

Choose a reason for hiding this comment

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

This should be a config that can be read from our variable in GitHub

Copy link
Member Author

Choose a reason for hiding this comment

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

resolved.

issue_number: context.payload.issue.number,
labels: ['question'],
});
const slackWebhook = process.env.SLACK_WEBHOOK;
Copy link
Member

Choose a reason for hiding this comment

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

Test if this is working

Copy link
Member

Choose a reason for hiding this comment

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

also this should go into a specific channel

Copy link
Member Author

Choose a reason for hiding this comment

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

tested and we can add the channel webhook as a secret.

owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.payload.issue.number,
labels: ['question'],
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

added as a variable that can be added in the gh variables section.

Comment on lines 17 to 21
const { data: orgMembers } = await github.orgs.listMembers({
org: context.repo.owner,
role: 'all'
});
const isOrgMember = orgMembers.some(member => member.login === commenter);
Copy link
Member

Choose a reason for hiding this comment

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

This should be an array of usernames that we set as a variable.

Copy link
Member Author

Choose a reason for hiding this comment

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

updated.

@bodhish
Copy link
Member

bodhish commented Oct 27, 2024

@tellmeY18 status 🤔

@bodhish
Copy link
Member

bodhish commented Nov 5, 2024

@coderabbitai full review

Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

✅ Actions performed

Full review triggered.

Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

A new GitHub Actions workflow file named notify-non-core-qn.yml has been added to automate notifications to the core team when non-core contributors post questions in issue comments. This workflow triggers on issue comment creation, checks if the commenter is an organization member, and if not, processes the comment for specific keywords. It adds labels to the issue and sends a notification to the core team via Slack, including error handling and logging for debugging.

Changes

File Path Change Summary
.github/workflows/notify-non-core-qn.yml Added a new workflow to notify the core team when non-core contributors post questions.

Assessment against linked issues

Objective Addressed Explanation
Automatically add a "question" label to an issue for non-core comments (8847)
Remove the "question" label when a core team member comments (8847) The workflow does not handle label removal.

Possibly related PRs

Poem

In the garden of code, where comments bloom,
A signal is sent, dispelling the gloom.
Core team, take heed, for questions arise,
From non-core friends, beneath the bright skies.
With labels and Slack, we’ll keep track with glee,
In this vibrant patch, all voices are free! 🐇✨


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>, 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 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.

@bodhish
Copy link
Member

bodhish commented Nov 11, 2024

@coderabbitai full review

Copy link
Contributor

coderabbitai bot commented Nov 11, 2024

✅ Actions performed

Full review triggered.

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: 3

🧹 Outside diff range and nitpick comments (2)
.github/workflows/notify-non-core-qn.yml (2)

13-17: Consider using GitHub Variables instead of Secrets for non-sensitive configurations.

While secrets provide good security, they're primarily intended for sensitive data. For better maintainability and easier configuration updates, consider:

  • Moving ALLOWED_USERNAMES, QUESTION_KEYWORDS, and QUESTION_LABELS to GitHub Variables
  • Keep only SLACK_WEBHOOK as a secret since it's sensitive
-    env:
-      ALLOWED_USERNAMES: ${{ secrets.ALLOWED_USERNAMES }}
-      QUESTION_KEYWORDS: ${{ secrets.QUESTION_KEYWORDS }}
-      QUESTION_LABELS: ${{ secrets.QUESTION_LABELS }}
-      SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+    env:
+      ALLOWED_USERNAMES: ${{ vars.ALLOWED_USERNAMES }}
+      QUESTION_KEYWORDS: ${{ vars.QUESTION_KEYWORDS }}
+      QUESTION_LABELS: ${{ vars.QUESTION_LABELS }}
+      SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

24-25: Add rate limiting for comment processing.

To prevent potential abuse, consider adding rate limiting for processing comments from non-core members.

           script: |
             console.log('Script started');
+            // Rate limiting check
+            const rateLimitResponse = await github.rest.rateLimit.get();
+            if (rateLimitResponse.data.resources.core.remaining < 100) {
+              console.log('Rate limit too low, skipping processing');
+              return;
+            }
+
             const commenter = context.payload.comment.user.login;

Also applies to: 31-33

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 68bfde4 and 3b1917d.

📒 Files selected for processing (1)
  • .github/workflows/notify-non-core-qn.yml (1 hunks)
🔇 Additional comments (2)
.github/workflows/notify-non-core-qn.yml (2)

1-9: LGTM! Workflow configuration is well-structured.

The workflow trigger and permissions are appropriately configured for the intended functionality.


1-80: Verify workflow functionality with test cases.

Please ensure the workflow is tested with the following scenarios:

  1. Comment from core team member (should be ignored)
  2. Comment from non-core member without question (should be ignored)
  3. Comment from non-core member with question (should trigger labels and notification)
  4. Comment with special characters in the question
  5. Error scenarios (invalid webhook, permission issues)

.github/workflows/notify-non-core-qn.yml Outdated Show resolved Hide resolved
.github/workflows/notify-non-core-qn.yml Outdated Show resolved Hide resolved
.github/workflows/notify-non-core-qn.yml Outdated Show resolved Hide resolved
@github-actions github-actions bot added the Deploy-Failed Deplyment is not showing preview label Nov 12, 2024
const issueUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/issues/${context.payload.issue.number}`;
const issueTitle = context.payload.issue.title;
const issueNumber = context.payload.issue.number;
console.log('Issue URL:', issueUrl);
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we should keep these logs

ALLOWED_USERNAMES: ${{ vars.ALLOWED_USERNAMES }}
QUESTION_KEYWORDS: ${{ vars.QUESTION_KEYWORDS }}
QUESTION_LABELS: ${{ vars.QUESTION_LABELS }}
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
Copy link
Member

Choose a reason for hiding this comment

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

The steps should be skipped if the variables/ secrets are not available

@bodhish bodhish merged commit 7cb54b3 into ohcnetwork:develop Nov 12, 2024
20 of 21 checks passed
Copy link

@tellmeY18 Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes required Deploy-Failed Deplyment is not showing preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automate Labeling of Issues Based on Comments from Non-Core Members
3 participants