-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Update github-trigger-event-options.adoc #9345
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.
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
base: master
Are you sure you want to change the base?
Conversation
@@ -96,6 +96,13 @@ a| * `opened` | |||
|
|||
|=== | |||
|
|||
All pipelines triggered by link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request[pull request events] also have the following xref:variables/#pipeline-values[pipeline values] are also populated: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All pipelines triggered by link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request[pull request events] also have the following xref:variables/#pipeline-values[pipeline values] populated:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively:
For all pipelines triggered by link:[https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_requestpull request events] the following xref:variables/#pipeline-values[pipeline values] are also populated:
* `pipeline.event.github.pull_request.draft`: a boolean value indicating whether the pull request is a draft | ||
* `pipeline.event.github.pull_request.title`: the title of the pull request | ||
* `pipeline.event.github.pull_request.number`: the numeric identifier of the pull request | ||
These values are extracted directly from the GitHub event payload. The part after prefix `pipeline.event.github.*` matches the corresponding field in the pull request event structure described in link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request[this page]. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There needs to be an empty line between the sentence "All pipelines triggered by pull request events also have the following pipeline values populated:" and the first item of the list.
And also a full stop at the end of each item.
All pipelines triggered by link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request[pull request events] also have the following xref:variables/#pipeline-values[pipeline values] are also populated:
* `pipeline.event.github.pull_request.base.ref`: the name of the *base* (or target) branch of the PR - that is the branch that will receive the changes.
* `pipeline.event.github.pull_request.head.ref`: the name of the *head* branch of the PR - that is the branch containing the changes to be merged.
* `pipeline.event.github.pull_request.draft`: a boolean value indicating whether the pull request is a draft.
* `pipeline.event.github.pull_request.title`: the title of the pull request.
* `pipeline.event.github.pull_request.number`: the numeric identifier of the pull request.
These values are extracted directly from the GitHub event payload. The part after prefix `pipeline.event.github.*` matches the corresponding field in the pull request event structure described in link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request[this page].
```
Description
A brief description of the changes.
Reasons
A link to a GitHub and/or JIRA issue (if applicable).
Otherwise, a brief sentence about why you made these changes.
Content Checklist
Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.
Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸: