~sircmpwn/sr.ht-docs

ref: 8f4d5ccd2765ae841f529f8d9bde468a187d4987 sr.ht-docs/builds.sr.ht/triggers.md -rw-r--r-- 1.0 KiB
8f4d5ccdDrew DeVault Add frontmatter to all pages 2 years ago

At the end of a job or a job group, you can execute triggers based on the outcome of the job. The basic format is (in JSON):

{
    "action": "trigger type",
    "condition": "when to execute this trigger",
    [...action-specific configuration...]
}

Or in YAML:

triggers:
  - action: trigger type
    condition: when to execute this trigger
    ...action-specific configuration...

Condition may be one of the following:

  • always: execute the trigger after every build
  • failure: execute the trigger after a failed build
  • success: execute the trigger after a successful build

The following actions are available:

#email

Sends an email summarizing the build results.

Configuration

  • to: The value of the "To" header in the outgoing email, e.g. your email address or e.g. Jim Jimson <jim@example.org>, Bob Bobson <bob@example.org>

#webhook

Submits the job status (as it would be returned by GET /api/jobs/:id) as a POST request to a specified URL.

Configuration

  • url: The URL to submit the HTTP request to