Skip to content

Commit 8c27aa6

Browse files
authored
SC-2677: Add new GitHub trigger event option & pipeline values (#9753)
* Add new GitHub trigger event option * Update pipeline values list * Update github-trigger-event-options.adoc * Update pipeline-values.adoc * Update pipeline-values.adoc
1 parent 9987542 commit 8c27aa6

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,6 +485,20 @@ d| [.nowrap]#GitHub App#
485485
| [.circle-green]#**Yes**#
486486
| [.circle-red]#**No**#
487487

488+
| `pipeline.event.github.comment.body`
489+
d| [.nowrap]#GitHub App#
490+
| Boolean
491+
| The pull request comment body with leading/trailing whitespace removed, if a pipeline was triggered via PR comment. For pipelines triggered in other ways, this value is undefined.
492+
| [.circle-green]#**Yes**#
493+
| [.circle-red]#**No**#
494+
495+
| `pipeline.event.github.sender.type`
496+
d| [.nowrap]#GitHub App#
497+
| String
498+
| The type of GitHub user that emitted the event triggering the pipeline. Possible values are `User`, `Organization`, and `Bot`.
499+
| [.circle-green]#**Yes**#
500+
| [.circle-red]#**No**#
501+
488502
| `pipeline.deploy.component_name`
489503
d| [.nowrap]#GitHub App#
490504
| 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
@@ -54,6 +54,7 @@ GitHub App triggers allow you to define the work to do (pipeline) when an event
5454
* *PR marked ready for review*: Trigger a pipeline when a PR is taken out of draft mode and marked ready for review. See the link:https://docs.github.com/en/webhooks/webhook-events-and-payloads?actionType=review_requested#pull_request[GitHub docs for pull request review requested].
5555
* *"run-ci" label added to PR*: Trigger a pipeline when a label "run-ci" is added to a PR. See the link:https://docs.github.com/en/webhooks/webhook-events-and-payloads?actionType=labeled#pull_request[GitHub docs for pull request labelled].
5656
* *Pushes to open non-draft PRs*: Trigger a pipeline when there is a push to a branch with an open PR that is not in draft mode.
57+
* *PR comment is exactly "run-ci"*: Trigger a pipeline when the comment "run-ci" is added to a pull request. This works for general PR comments (link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#issue_comment[`issue_comment` events]) and inline code comments (link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review_comment[`pull_request_review_comment` events]). It does *not* work for comments added in the top-level comment field when submitting a review (link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review[`pull_request_review` events]).
5758

5859
NOTE: **Forked pull requests** never trigger GitHub App pipelines.
5960

0 commit comments

Comments
 (0)