Closed
Fix "Generate API docs JSON" workflow failing on pull_request events#291
Conversation
…events Co-authored-by: star-e <13654656+star-e@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix failing GitHub Actions job Generate API docs JSON
Fix "Generate API docs JSON" workflow failing on pull_request events
Aug 17, 2026
star-e
marked this pull request as ready for review
August 17, 2026 10:02
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On
pull_requestevents,github.refresolves torefs/pull/<N>/merge— a virtual ref thatactions/checkoutcannot fetch directly — causing the workflow to fail withfatal: couldn't find remote ref.Changes
generate-api-docs.yml: Added a dedicatedpull_requestbranch in the "Get ref" step that usesgithub.sha(the actual merge commit SHA) instead ofgithub.ref, which is only valid for tag/branch push events.