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

Add action runs when labels are added or removed #18

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

Conversation

coolacid
Copy link

@coolacid coolacid commented Jan 17, 2025

This PR adds two settings to the Github Actions On issues statement. It adds the labeled and unlabeled issue types.

By adding these two, actions are run when a label is added or removed to an issue. This allows faster response time when adding or removing the the incident label.

Summary by CodeRabbit

  • Chores
    • Updated GitHub Actions workflow to trigger on additional issue event types (labeled and unlabeled)

Copy link

coderabbitai bot commented Jan 17, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow configuration for health checks. The change expands the trigger conditions for the issues event in the workflow file, adding labeled and unlabeled event types alongside the existing opened and closed types. This adjustment allows the workflow to respond to more issue-related events, providing broader monitoring and automation capabilities.

Changes

File Change Summary
.github/workflows/health-check.yml Updated issues event types to include labeled and unlabeled in addition to opened and closed

Poem

🐰 A Workflow's Whisker Twitch 🏷️

Labels dance, issues take flight,
Workflow watches with rabbit delight!
Opened, closed, labeled with care,
Automation's magic everywhere!
Health checks hop with newfound might! 🚀


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

@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/health-check.yml (1)

10-10: Consider filtering for specific labels to optimize workflow runs.

While adding labeled and unlabeled events will help with incident monitoring, this trigger will run for all label changes. Since this workflow performs resource-intensive operations (npm install, build, deploy), consider filtering for specific labels to avoid unnecessary runs.

-    types: [opened, closed, labeled, unlabeled]
+    types: [opened, closed, labeled, unlabeled]
+    # Only run on incident label changes
+    if: |
+      github.event.label.name == 'incident' ||
+      contains(github.event.issue.labels.*.name, 'incident')
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c586313 and 57dd925.

📒 Files selected for processing (1)
  • .github/workflows/health-check.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/health-check.yml (1)

10-10: Verify alignment with PR objective.

The PR objective specifically mentions improving response time for the incident label. However, the current implementation triggers the workflow for all label changes. Please confirm if this broader scope is intentional.

Let's check if the incident label exists and is actively used:

✅ Verification successful

The broader label scope is appropriate for a status page system

While the PR objective mentions improving response time for the incident label, triggering on all label events is the correct approach for a status page that needs to reflect all issue status changes. The incident label exists and is actively used (2 issues), but other label changes might also be relevant for the system's overall status representation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for the existence and usage of the 'incident' label
# Expected: Find references to the 'incident' label in issues

# Check if the incident label exists and is used in issues
gh api graphql -f query='
query($owner:String!, $name:String!) {
  repository(owner:$owner, name:$name) {
    labels(first:100) {
      nodes {
        name
        issues {
          totalCount
        }
      }
    }
  }
}' -F owner=Bullrich -F name=Status-Page | jq '.data.repository.labels.nodes[] | select(.name=="incident")'

Length of output: 396


Script:

#!/bin/bash
# Check the workflow implementation for label handling
cat .github/workflows/health-check.yml

Length of output: 3648

@coolacid
Copy link
Author

The nitpick comment suggests an if statement in the on section. I've checked where I can, and asked ChatGPT to be sure, if statements are not supported there.

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.

1 participant