Skip to content

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.

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

Merged
merged 7 commits into from
Apr 22, 2025
Merged

Update github-trigger-event-options.adoc #9345

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3626b02
Update github-trigger-event-options.adoc
BeFunes Apr 15, 2025
99f8e8d
Merge branch 'master' into Benny/update-github-trigger-events.page
BeFunes Apr 15, 2025
6593cf0
Merge branch 'master' into Benny/update-github-trigger-events.page
BeFunes Apr 15, 2025
8d5bada
address comments
BeFunes Apr 18, 2025
b2c819d
Merge branch 'master' into Benny/update-github-trigger-events.page
BeFunes Apr 22, 2025
1fcdbd1
Update jekyll/_cci2/github-trigger-event-options.adoc
BeFunes Apr 22, 2025
845d8eb
Merge branch 'master' into Benny/update-github-trigger-events.page
BeFunes Apr 22, 2025
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
7 changes: 7 additions & 0 deletions jekyll/_cci2/github-trigger-event-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor

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:

Copy link
Contributor

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:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed!

* `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].

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bullet list is not properly formatted:
Screenshot 2025-04-15 at 22 40 22

Copy link
Contributor

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].
```

Config orchestration tools are available from within your pipelines are as follows:

Expand Down