jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-25 02:17:36 -05:00
Code Issues Projects Releases Wiki Activity

Clarification of the github context variables github.ref and github.ref_name (#41375)

Browse Source 
Co-authored-by: Sharra-writes <sharra-writes@github.com>
This commit is contained in:
Pablo Collazo Collarte
2025-12-03 20:10:25 +01:00
committed by GitHub
parent e1f97ecaa7
commit e1e4109926
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
data/reusables/actions/ref-description.md
View File

@@ -1 +1 @@
The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by `push`, this is the branch or tag ref that was pushed. For workflows triggered by `pull_request`, this is the pull request merge branch. For workflows triggered by `release`, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is `refs/heads/<branch_name>`. For pull requests events except `pull_request_target`, it is `refs/pull/<pr_number>/merge`. `pull_request_target` events have the `ref` from the base branch. For tags it is `refs/tags/<tag_name>`. For example, `refs/heads/feature-branch-1`.
The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by `push`, this is the branch or tag ref that was pushed. For workflows triggered by `pull_request` that were not merged, this is the pull request merge branch. If the pull request was merged, this is the head branch. For workflows triggered by `release`, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is `refs/heads/<branch_name>`. For pull requests events except `pull_request_target` that were not merged, it is `refs/pull/<pr_number>/merge`. `pull_request_target` events have the `ref` from the base branch. For tags it is `refs/tags/<tag_name>`. For example, `refs/heads/feature-branch-1`.

2
data/reusables/actions/ref_name-description.md
View File

@@ -1 +1 @@
The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on {% data variables.product.prodname_dotcom %}. For example, `feature-branch-1`.<br><br>For pull requests, the format is `<pr_number>/merge`.
The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on {% data variables.product.prodname_dotcom %}. For example, `feature-branch-1`.<br><br>For pull requests that were not merged, the format is `<pr_number>/merge`.