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

Commit db2bd9b

Browse files
committed
Refine documentation
1 parent 115cb9a commit db2bd9b

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/ods-configuration.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ pipeline:
2121
- trigger:
2222
event: ["repo:refs_changed", "pr:*"]
2323
branches: ["feature/*"]
24+
exceptBranches: ["feature/foo"]
2425
prComment: "/build"
2526
tasks:
2627
- name: build
@@ -71,7 +72,14 @@ Next to the tasks you specify, `ods-pipeline` will automatically inject two task
7172

7273
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.
7374

74-
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, specific branches or pull request comments may be specified via the `branches` and `prComment` properties of the trigger specification. 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. Only the first pipeline matching all conditions in the trigger section will be executed.
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:
76+
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.
81+
82+
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.
7583

7684
You can also specify further final tasks to be added to the pipeline by specifying them under `finally`. Example:
7785

0 commit comments

Comments
 (0)