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

fixes auto needs testing label #9025

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

rithviknishad
Copy link
Member

@rithviknishad rithviknishad commented Nov 6, 2024

Proposed Changes

  • fixes auto needs testing label action unable to comment

eg: https://github.com/ohcnetwork/care_fe/actions/runs/11704100972/job/32595822027
image

@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

    • Improved logic for adding the "needs testing" label based on pull request status and comments.
    • Enhanced reminder system for pull request authors to indicate readiness for testing.
  • Bug Fixes

    • Updated API method for creating comments to ensure compatibility and functionality.

@rithviknishad rithviknishad requested a review from a team as a code owner November 6, 2024 13:22
Copy link

coderabbitai bot commented Nov 6, 2024

Walkthrough

The pull request introduces modifications to the .github/workflows/auto-testing-label.yml workflow file. It updates the API method for creating comments on issues to a more recent version and refines the logic for applying the "needs testing" label. The conditions for labeling now include checks for pull request draft status and the presence of specific comments. Additionally, reminders are sent to authors when changes are required, and the label is removed if it is already applied under certain conditions.

Changes

File Change Summary
.github/workflows/auto-testing-label.yml - Updated method from github.issues.createComment to github.rest.issues.createComment.
- Refined logic for adding/removing the "needs testing" label based on pull request status and comments.

Poem

In the garden of code, where the pull requests play,
A label now dances, in a clearer way.
With comments and triggers, so bright and so keen,
"Ready for testing!" the rabbit has seen.
Hopping along, with a joyful little cheer,
Our workflow is better, let’s give a big cheer! 🐇✨


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.

Copy link

netlify bot commented Nov 6, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit cd9d382
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/672b6d942c9a39000833df0b
😎 Deploy Preview https://deploy-preview-9025--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.

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

🧹 Outside diff range and nitpick comments (2)
.github/workflows/auto-testing-label.yml (2)

Line range hint 41-49: Add error handling for API operations.

The API calls could fail due to various reasons (rate limits, network issues, etc.). Consider wrapping them in try-catch blocks for better error handling.

+              try {
                 await github.rest.issues.createComment({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   issue_number: pr.number,
                   body: 'Reminder: To add the "needs testing" label, comment "ready for testing" on this PR.'
                 });
                 if (pr.labels.some(label => label.name === 'needs testing')) {
                   await github.issues.removeLabel({
                     owner: context.repo.owner,
                     repo: context.repo.repo,
                     issue_number: pr.number,
                     name: 'needs testing'
                   });
                 }
+              } catch (error) {
+                core.warning(`Failed to manage PR labels/comments: ${error.message}`);
+              }

Line range hint 41-45: Enhance the reminder message for clarity.

The current message could be more informative about the workflow state.

-                  body: 'Reminder: To add the "needs testing" label, comment "ready for testing" on this PR.'
+                  body: 'Changes have been requested. The "needs testing" label has been removed. Once you\'ve addressed the requested changes, please comment "ready for testing" to re-add the label.'
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bbcfef0 and cd9d382.

📒 Files selected for processing (1)
  • .github/workflows/auto-testing-label.yml (1 hunks)
🔇 Additional comments (2)
.github/workflows/auto-testing-label.yml (2)

41-41: LGTM! Correct usage of the GitHub REST API.

The update to use github.rest.issues.createComment follows current best practices for the GitHub Actions API.


Line range hint 41-49: Verify the impact of label removal.

The automatic removal of the "needs testing" label on changes requested might affect other automation or tracking systems.

✅ Verification successful

Label removal is safe but consider documenting the behavior

The "needs testing" label is used in two workflows:

  • auto-testing-label.yml: Manages the label addition/removal (current workflow)
  • stale.yml: Uses it as an exempt label to prevent PRs from being marked as stale

The removal of the label is safe because:

  1. The stale workflow only uses it as an exemption, so removal won't trigger any unintended automation
  2. The label can be re-added by commenting "ready for testing" as mentioned in the automated comment
  3. No other workflows depend on this label for triggering actions
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for other workflows or actions that might depend on the "needs testing" label

# Test: Search for workflows using the "needs testing" label
echo "Checking other workflow files for 'needs testing' label usage..."
rg -l "needs testing" .github/workflows/

Length of output: 256


Script:

#!/bin/bash
# Let's check how the "needs testing" label is used in stale.yml
echo "Content of stale.yml regarding 'needs testing' label:"
rg -A 5 -B 5 "needs testing" .github/workflows/stale.yml

# Also check for any automation that adds this label
echo -e "\nChecking for automation that adds the label:"
rg -A 3 -B 3 'labels:.*needs testing|name:.*needs testing' .github/workflows/

Length of output: 2674

@bodhish
Copy link
Member

bodhish commented Nov 6, 2024

@rithviknishad nitpicks are good

Copy link

cypress bot commented Nov 6, 2024

CARE    Run #3821

Run Properties:  status check passed Passed #3821  •  git commit cd9d382230: fixes auto needs testing label
Project CARE
Branch Review rithviknishad/fix/auto-testing-label-not-commenting
Run status status check passed Passed #3821
Run duration 04m 47s
Commit git commit cd9d382230: fixes auto needs testing label
Committer Rithvik Nishad
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 125
View all changes introduced in this branch ↗︎

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.

3 participants