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

ci: Fix GitHub Actions Workflow Status Fetching and Update Output Handling #23103

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

Conversation

Odomey
Copy link

@Odomey Odomey commented Dec 27, 2024

Description

Closes: #XXXX

This PR modifies the script for retrieving and storing the status of the last completed GitHub Actions workflow. The key changes include:

Updated the API endpoint for fetching the workflow runs to correctly use github.head_ref instead of env.GITHUB_HEAD_REF. This ensures the correct branch reference is used in the API request.
Replaced the deprecated set-output command with direct writing to $GITHUB_OUTPUT. This change aligns with the updated GitHub Actions practices for output handling.
Critical lines updated:

Original:

"https://api.github.com/repos/${{ github.repository }}/actions/workflows/${{ env.WORKFLOW_ID }}/runs?per_page=1&status=completed&branch=${{ env.GITHUB_HEAD_REF }}" \

Modified:

"https://api.github.com/repos/${{ github.repository }}/actions/workflows/${{ env.WORKFLOW_ID }}/runs?per_page=1&status=completed&branch=${{ github.head_ref }}" \

Original:

echo "::set-output name=last_status::${last_status}"

Modified:

echo "last_status=${last_status}" >> $GITHUB_OUTPUT

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Chores
    • Updated the GitHub Actions workflow to improve branch reference handling and output management.

Copy link
Contributor

coderabbitai bot commented Dec 27, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the GitHub Actions workflow configuration in the .github/actions/last-workflow-status/action.yaml file. The changes focus on updating the API request URL by replacing the environment variable ${{ env.GITHUB_HEAD_REF }} with ${{ github.head_ref }}. Additionally, the output mechanism has been updated from the deprecated ::set-output command to using the GITHUB_OUTPUT environment variable, aligning with current GitHub Actions best practices.

Changes

File Change Summary
.github/actions/last-workflow-status/action.yaml - Updated branch reference from ${{ env.GITHUB_HEAD_REF }} to ${{ github.head_ref }}
- Replaced deprecated ::set-output with GITHUB_OUTPUT environment variable

Possibly related PRs

Suggested labels

Type: CI

Suggested reviewers

  • auricom
  • julienrbrt

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a533fd and ca7be8d.

📒 Files selected for processing (1)
  • .github/actions/last-workflow-status/action.yaml (1 hunks)
🔇 Additional comments (2)
.github/actions/last-workflow-status/action.yaml (2)

36-36: LGTM! Proper usage of GITHUB_OUTPUT

The change correctly implements the new output syntax, replacing the deprecated ::set-output command with the recommended GITHUB_OUTPUT environment file approach.


33-33: Consider handling empty head_ref for non-PR workflows

The github.head_ref is only available in pull request events. For other events (like push or manual triggers), it will be empty, which could cause the API request to fail.

Let's verify the workflow triggers and potential impact:

Consider adding a fallback to github.ref_name:

-"https://api.github.com/repos/${{ github.repository }}/actions/workflows/${{ env.WORKFLOW_ID }}/runs?per_page=1&status=completed&branch=${{ github.head_ref }}" \
+"https://api.github.com/repos/${{ github.repository }}/actions/workflows/${{ env.WORKFLOW_ID }}/runs?per_page=1&status=completed&branch=${{ github.head_ref || github.ref_name }}" \
✅ Verification successful

Let me generate another verification script to check the workflow usage:


The action is used only in simulation workflows triggered by schedule and release events

Based on the verification results, the last-workflow-status action is only used in simulation workflows (sims.yml, sims-052.yml, sims-050.yml, sims-nightly.yml) which are triggered by:

  • Scheduled cron jobs
  • Release publish events

Since these workflows don't use pull request events, using github.head_ref without a fallback is safe in this context as it's not required for the intended usage.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check workflow triggers and potential empty head_ref scenarios

# Check workflow files that might trigger this action
rg -l "uses: .*/last-workflow-status" -g "*.yml" -g "*.yaml"

# Check for non-PR event triggers in those workflows
rg "on:|workflow_dispatch:|push:|schedule:" -A 5 -g "*.yml" -g "*.yaml"

Length of output: 96970


Script:

#!/bin/bash
# Check workflow files for usage of last-workflow-status action and their triggers
rg -l "uses: .*last-workflow-status" .github/workflows/
rg "on:|pull_request:|push:|workflow_dispatch:" -A 5 .github/workflows/

Length of output: 77955


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.

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.

@Odomey Odomey changed the title Update action.yaml Fix GitHub Actions Workflow Status Fetching and Update Output Handling Dec 27, 2024
@julienrbrt julienrbrt changed the title Fix GitHub Actions Workflow Status Fetching and Update Output Handling ci: Fix GitHub Actions Workflow Status Fetching and Update Output Handling Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant