Skip to content

Commit 071379a

Browse files
authored
document pipeline value pipeline.event.github.pull_request.merged (#9601)
* Update github-trigger-event-options.adoc * Update pipeline-values.adoc
1 parent 463892b commit 071379a

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/guides/modules/ROOT/partials/pipelines-and-triggers/pipeline-values.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,13 @@ a| * GitLab: push, merge request
421421
| image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
422422
| image:guides:ROOT:icons/cancel.svg[cancel icon, role="no-border"]
423423

424+
| `pipeline.event.github.pull_request.merged`
425+
| GitHub App
426+
| Boolean
427+
| A boolean value indicating whether the pull request is has been merged. Only populated for pipelines triggered xref:guides:orchestrate:github-trigger-event-options.adoc#supported-trigger-options[by pull request events] (`pipeline.event.name = "pull_request"`).
428+
| image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
429+
| image:guides:ROOT:icons/cancel.svg[cancel icon, role="no-border"]
430+
424431
| `pipeline.deploy.component_name`
425432
| GitHub App
426433
| String

docs/guides/modules/orchestrate/pages/github-trigger-event-options.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ workflows:
113113

114114
* `pipeline.event.github.pull_request.title`: the title of the pull request.
115115
* `pipeline.event.github.pull_request.number`: the numeric identifier of the pull request.
116+
* `pipeline.event.github.pull_request.merged`: a boolean that indicates whether the PR was merged or not.
116117

117118
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[the GitHub docs].
118119

0 commit comments

Comments
 (0)