docs(actions): clarify github.ref event semantics - #46047
aniruddhaadak80 wants to merge 1 commit into
Conversation
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
I'm going to close this out—we haven't marked this as ready for community contributions yet, and are yet to make a determination about the best way to tackle the problem. Apologies that this won't be the outcome you were hoping for |
Why:
Closes: #43055
The
github.refdescription is rendered inside the context reference table as one dense sentence that mixes event types and makes the pull request cases difficult to distinguish. The issue's reproduction shows that a mergedpull_requestrun uses the base branch, while unmerged runs use the pull request merge ref. A previous clarification corrected one phrase, but did not separate the event-specific cases or make the ref formats explicit.What's being changed (if available, include any code snippets, screenshots, or gifs):
github.refdescription into explicitpush, unmerged and mergedpull_request,pull_request_target,release, and fallback cases.npm run build- passed.npm run lint-content -- --paths data/reusables/actions/ref-description.md content/actions/reference/workflows-and-actions/contexts.md- passed with no errors.npm test -- src/content-render/tests/render-changed-and-deleted-files.ts- 2 tests passed.git diff --check- passed.Check off the following: