Skip to content

Commit

Permalink
Addresses #35215 - corrected example for github.ref pull requests events
Browse files Browse the repository at this point in the history
  • Loading branch information
anand-kashyap committed Jan 10, 2025
1 parent 5c9d8bc commit 155d24b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion data/reusables/actions/ref-description.md
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`, 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 it is `refs/pull/<pr_number>/merge`, and 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`, 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 and for tags it is `refs/tags/<tag_name>`. For example, `refs/heads/feature-branch-1`.

0 comments on commit 155d24b

Please sign in to comment.