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

Fix: Auto label failed preview deploys #10051

Conversation

rajku-dev
Copy link
Contributor

@rajku-dev rajku-dev commented Jan 19, 2025

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

  • Chores
    • Updated GitHub Actions workflow configuration for handling deployment labels
    • Modified label removal process to align with updated GitHub API requirements

@rajku-dev rajku-dev requested a review from a team as a code owner January 19, 2025 08:03
Copy link
Contributor

coderabbitai bot commented Jan 19, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow configuration for labeling failed preview deploys. The change involves updating the parameter format in the removeLabel function call, specifically transitioning from a list-based label specification to a key-value pair format. This adjustment suggests an alignment with updated GitHub API interaction requirements for label management.

Changes

File Change Summary
.github/workflows/label-deploy-failed.yml Updated label removal parameter from labels: ["Deploy-Failed"] to name: "Deploy-Failed"

Possibly related PRs

Suggested reviewers

  • rithviknishad
  • shivankacker

Poem

🐰 A workflow tweak, so subtle and neat
Labels dance with a new API beat
From list to name, the change takes flight
GitHub actions now shine so bright!
Deployment labels, hop into place 🚀


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 Jan 19, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 34c1a8d
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/678cb1bdb74842000899631f
😎 Deploy Preview https://deploy-preview-10051--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.

@github-actions github-actions bot added the Deploy-Failed Deplyment is not showing preview label Jan 19, 2025
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

🧹 Nitpick comments (1)
.github/workflows/label-deploy-failed.yml (1)

40-40: Inconsistent label parameter format between add and remove operations.

While the change to use name parameter in removeLabel is correct according to the GitHub REST API, the addLabels operation on line 25 still uses the array format. For consistency and maintainability, consider using the newer GitHub REST API endpoints for both operations.

       github.rest.issues.addLabels({
         issue_number: context.issue.number,
         owner: context.repo.owner,
         repo: context.repo.repo,
-        labels: ["Deploy-Failed"]
+        labels: ["Deploy-Failed"]  // Consider using github.rest.issues.addLabel with name parameter instead
       })
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 206ee47 and 34c1a8d.

📒 Files selected for processing (1)
  • .github/workflows/label-deploy-failed.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: CodeQL-Build
  • GitHub Check: cypress-run (1)
🔇 Additional comments (1)
.github/workflows/label-deploy-failed.yml (1)

40-40: Verify the GitHub REST API format change.

Let's confirm that the new format using name parameter is the correct approach according to GitHub's API documentation.

✅ Verification successful

GitHub REST API format is correct and working

The name parameter is the correct format according to GitHub's API, and recent workflow runs confirm it's working properly.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the correct GitHub REST API format for removing labels
# Expected results: Documentation showing that 'name' parameter is the correct format

# Check the GitHub REST API documentation for removing a label
gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /repos/ohcnetwork/care_fe/issues/10051 \
  --jq '.url' | xargs curl -s | jq '.labels'

# List recent workflow runs to check if the new format is working
gh run list --workflow=label-deploy-failed.yml --limit 5 --json conclusion,event,status

Length of output: 855

@rajku-dev
Copy link
Contributor Author

I added the label on purpose by commenting "Deploy Preview failed"

@rajku-dev rajku-dev closed this Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deploy-Failed Deplyment is not showing preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant