Skip to content
This repository was archived by the owner on Mar 21, 2025. It is now read-only.

Commit 53aab77

Browse files
committed
Clarify semantics of omitting trigger criteria
1 parent 411235f commit 53aab77

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/ods-configuration.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ Next to the tasks you specify, `ods-pipeline` will automatically inject two task
7272

7373
The `ods-finish` task is added as a final task to the pipeline. Final tasks run at the end, regardless whether all previous tasks succeeded. The `ods-finish` sets the Bitbucket build status and deals with Nexus artifacts, etc.
7474

75-
Using the `trigger` section, different pipelines may be configured and will be run based on the Bitbucket webhook event received. To further narrow down pipeline selection, the following criteria may be specified:
75+
Using the `trigger` section, multiple pipelines can be configured, and the web hook data is matched against the conditions specified in the `trigger` section, selecting the pipeline to run. The following selection criteria may be specified:
7676

77-
`event`:: List of events that trigger the pipeline. Patterns as supported by link:https://pkg.go.dev/path#Match[`path.Match`] may be used to match events.
78-
`branches`:: List of branches to which the triggering event shall refer. Patterns as supported by link:https://pkg.go.dev/path#Match[`path.Match`] may be used to match branches.
79-
`exceptBranches`:: List of branches to which the triggering event may not refer. Patterns as supported by link:https://pkg.go.dev/path#Match[`path.Match`] may be used to match the excluded branches.
80-
`prComment`:: Define a prefix a comment has to start with. Might be used to implement functionality like slash commands.
77+
`event`:: List of events that trigger the pipeline. Patterns as supported by link:https://pkg.go.dev/path#Match[`path.Match`] may be used to match events. In case the `event` property is omitted in `ods.yaml`, any supported event will trigger the respective pipeline.
78+
`branches`:: List of branches to which the triggering event shall refer. Patterns as supported by link:https://pkg.go.dev/path#Match[`path.Match`] may be used to match branches. Not specifying the `branches` criterion will match webhook events on any branch in the repository.
79+
`exceptBranches`:: List of branches to which the triggering event may not refer. Patterns as supported by link:https://pkg.go.dev/path#Match[`path.Match`] may be used to match the excluded branches. Omitting the criterion will lead to none of the branches referred to in the webhook event to be excluded.
80+
`prComment`:: Define a prefix a comment has to start with. Might be used to implement functionality like slash commands. If omitted, comments won't be considered in the pipeline selection process.
8181

8282
Currently, the Bitbucket events `repo:refs_changed` (fired on push to a Bitbucket repository) and any Pull Request related events (event types with prefix `pr:`) are supported (for a full list of events, please refer to the link:https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html[Atlassian Bitbucket Documentation]). Only the first pipeline matching all conditions in the trigger section will be executed. If no trigger section is specified, the pipeline will always match.
8383

0 commit comments

Comments
 (0)