Skip to content

docs(actions): clarify github.ref event semantics #46047

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.

Sign up for GitHub

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

Closed
aniruddhaadak80 wants to merge 1 commit into from
+1 −1
Closed

docs(actions): clarify github.ref event semantics #46047

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion data/reusables/actions/ref-description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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` that were not merged, this is the pull request merge branch. If the pull request was merged, this is the branch it was merged into. 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 request 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`. For more information about pull request merge branches, see [AUTOTITLE](/pull-requests/reference/pull-requests#pull-request-refs-and-merge-branches).
The fully-formed ref of the branch or tag that triggered the workflow run. The value depends on the event:<br><br>For a `push` event, this is the branch or tag ref that was pushed. For a `pull_request` event that was not merged, this is the pull request merge branch (`refs/pull/<pr_number>/merge`). If the pull request was merged, this is the branch it was merged into (`refs/heads/<base_branch>`). For a `pull_request_target` event, this is the ref from the base branch. For a `release` event, this is the release tag created. For other events, this is the branch or tag ref that triggered the workflow run.<br><br>This property is only set if a branch or tag is available for the event type. Branch refs use `refs/heads/<branch_name>` and tag refs use `refs/tags/<tag_name>`. For more information about pull request merge branches, see [AUTOTITLE](/pull-requests/reference/pull-requests#pull-request-refs-and-merge-branches).
Loading