Skip to content

chore: use sha instead of ref checkout action#4952

Merged
tomiir merged 4 commits intomainfrom
fix/merge-queue
Sep 3, 2025
Merged

chore: use sha instead of ref checkout action#4952
tomiir merged 4 commits intomainfrom
fix/merge-queue

Conversation

@tomiir
Copy link
Copy Markdown
Collaborator

@tomiir tomiir commented Sep 3, 2025

Description

Merge Queue runs are failing to fetch the references for the branches.
What usually causes this
1. Workflow not triggered on merge_group: If checks only run on pull_request or push, they won’t see the merge-queue ref GitHub creates.
2. actions/checkout not checking out the queue ref: If we don’t pass ref: ${{ github.ref }} (and sometimes need fetch-depth: 0), checkout may try to fetch a default ref and then explicitly fetch the queue ref, which 404s because it was never requested (or already GC’d).
3. Your job pushes/updates the ref: The gh-readonly-queue ref is read-only and ephemeral. Any step trying to push back to it (e.g., “update branch,” “commit changes,” codegen, etc.) will fail or race the ref disappearing.

Changes

  • Updates CI workflows to always check out by commit SHA instead of branch/ref.
    actions/checkout@v4 now uses ref: ${{ github.sha }} with fetch-depth: 0 in all jobs.
    • The ui-test workflow now receives the commit SHA instead of the ephemeral gh-readonly-queue/... ref.

Type of change

  • Chore (non-breaking change that addresses non-functional tasks, maintenance, or code quality improvements)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Associated Issues

Closes APKT-3638

Copilot AI review requested due to automatic review settings September 3, 2025 12:07
@linear
Copy link
Copy Markdown

linear bot commented Sep 3, 2025

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Sep 3, 2025

⚠️ No Changeset found

Latest commit: 62d0df3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel bot commented Sep 3, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
appkit-basic-html Ready Ready Preview Comment Sep 3, 2025 0:38am
appkit-demo Ready Ready Preview Comment Sep 3, 2025 0:38am
appkit-gallery Ready Ready Preview Comment Sep 3, 2025 0:38am
appkit-laboratory Canceled Canceled Comment Sep 3, 2025 0:38am
10 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
appkit-basic-example Ignored Ignored Sep 3, 2025 0:38am
appkit-basic-sign-client-example Ignored Ignored Sep 3, 2025 0:38am
appkit-basic-up-example Ignored Ignored Sep 3, 2025 0:38am
appkit-ethers5-bera Ignored Ignored Sep 3, 2025 0:38am
appkit-nansen-demo Ignored Ignored Sep 3, 2025 0:38am
appkit-vue-solana Ignored Ignored Sep 3, 2025 0:38am
appkit-wagmi-cdn-example Ignored Ignored Sep 3, 2025 0:38am
ethereum-provider-wagmi-example Ignored Ignored Sep 3, 2025 0:38am
next-wagmi-solana-bitcoin-example Ignored Ignored Sep 3, 2025 0:38am
vue-wagmi-example Ignored Ignored Sep 3, 2025 0:38am

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates CI workflows to use commit SHAs instead of branch references for checkout operations to prevent merge queue failures. The changes ensure that GitHub Actions workflows check out specific commits rather than potentially ephemeral branch references.

  • Adds explicit ref: ${{ github.sha }} and fetch-depth: 0 to all actions/checkout@v4 steps
  • Updates the ui-test workflow to receive commit SHA instead of branch reference
  • Removes various explanatory comments throughout the workflow file

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 3, 2025

Warnings
⚠️

Workflow file .github/workflows/pr_checks.yml has been modified

Generated by 🚫 dangerJS against 62d0df3

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 3, 2025

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 78.33% 34855 / 44497
🔵 Statements 78.33% 34855 / 44497
🔵 Functions 76.09% 3838 / 5044
🔵 Branches 86.66% 8225 / 9491
File CoverageNo changed files found.
Generated in workflow #14805 for commit 62d0df3 by the Vitest Coverage Report Action

@arein
Copy link
Copy Markdown
Contributor

arein commented Sep 3, 2025

Updates CI workflows to always check out by commit SHA instead of branch/ref.
• actions/checkout@v4 now uses ref: ${{ github.sha }} with fetch-depth: 0 in all jobs.
• The ui-test workflow now receives the commit SHA instead of the ephemeral gh-readonly-queue/... ref.

Not ultra clear what the bug hypothesis is. Sounds like branch/ref is getting deleted and github.sha is not?

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.

5 participants