diff --git a/data/reusables/actions/ref-description.md b/data/reusables/actions/ref-description.md index 70fa9f1e1446..49e384ac7b87 100644 --- a/data/reusables/actions/ref-description.md +++ b/data/reusables/actions/ref-description.md @@ -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/`, for pull requests it is `refs/pull//merge`, and for tags it is `refs/tags/`. 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/`, for pull requests events `except pull_request_target` it is `refs/pull//merge`, `pull_request_target` events have the `ref` from the base branch and for tags it is `refs/tags/`. For example, `refs/heads/feature-branch-1`.