GerritTriggerSpec

GerritTriggerSpec
GerritTriggerSpec

The configurations of a Gerrit Trigger decides which pipeline is required to be triggered depending on kind of event received.

JSON Example
{
    "branch": "master",
    "configurations": [
        {
            "pipeline": "rest_pipeline",
            "input": {},
            "eventType": "change-merged",
            "failureComment": "Pipeline Execution Failed",
            "successComment": "Pipeline Execution Successful"
        },
        {
            "pipeline": "rest_pipeline",
            "input": {},
            "eventType": "patchset-created",
            "verifiedLabel": "Verified",
            "failureComment": "Pipeline Failed",
            "successComment": "Pipeline Completed"
        }
    ],
    "description": "string",
    "enabled": true,
    "exclusions": [
        {
            "type": "PLAIN",
            "value": "example.txt"
        }
    ],
    "gerritProject": "TestGerritProject",
    "inclusions": [
        {
            "type": "PLAIN",
            "value": "example.txt"
        }
    ],
    "listener": "Gerrit-Listener",
    "name": "My-Name",
    "prioritizeExclusion": true,
    "project": "My-Project"
}
string
branch
Required

Gerrit Project Branch on which the change has to be monitored.

configurations
Optional

The configuration of an Gerrit Event.

string
description
Required

A human-friendly description.

boolean
enabled
Optional

Indicates that this trigger will be addressed on receiving respective events.

exclusions
Optional

Provide file exclusions as conditions for the trigger.

string
gerritProject
Required

Gerrit Project which is to be monitored for the change.

inclusions
Optional

Provide file inclusions as conditions for the trigger.

string
listener
Required

Gerrit Listener which will receive the events for this trigger.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

boolean
prioritizeExclusion
Optional

Prioritize Exclusion ensures that pipelines are not triggered even if any of the files in a commit match the specified files in the exclusion paths or regex.

string
project
Optional

The project this entity belongs to.