Trigger fields

Every trigger has a name, a paused state, deployment conditions or a schedule, and one action.

Deployment conditions

Every condition supplied must match. A trigger with no conditions fires on every deployment the workspace receives.

Field	Description
`environmentIds`	Only fire for deployments to these environments. Mutually exclusive with `environmentPattern`.
`environmentPattern`	Only fire for deployments to environments whose name matches this pattern, such as `preview/*`. Mutually exclusive with `environmentIds`.
`deployTargetPattern`	Only fire for deployments whose deploy target URL matches this pattern.
`branchPattern`	Only fire for deployments of a branch matching this pattern.
`repositoryPattern`	Only fire for deployments from a repository whose `owner/name` matches this pattern, such as `acme/web` or `acme/*`. A deployment that names no repository never matches.
`servicePattern`	Only fire for deployments whose service matches this pattern. A deployment that names no service never matches a trigger carrying one, so adding a service pattern to an existing trigger silently stops it firing until your pipeline sends the field. See Deployments.

Patterns are case-insensitive, and * matches any run of characters. A deployment with no deploy target, branch, repository or service never matches a pattern on that field. environmentPattern matches the name of the QA Wolf environment the deployment resolved to, not the name your pipeline sent. See Deployments.

Schedule

Field	Description
`cadence`	`hourly`, `daily` or `weekly`.
`environmentId`	The environment the runs happen in, by id or alias.
`timezoneId`	The IANA timezone the schedule is read in, such as `America/New_York`. Required for every cadence, `hourly` included. It sets the wall clock `timeOfDay` is read against, and the day boundaries `dayOfWeek` and `daysOfWeek` are read against.
`timeOfDay`	When a daily or weekly schedule fires, as `HH:mm`. Required when the cadence is daily or weekly.
`dayOfWeek`	The one day a weekly schedule fires on, named in lower case: `monday` through `sunday`. Required when the cadence is weekly.
`daysOfWeek`	The only days an hourly or daily schedule fires on, as an array of lower-case day names. Name each day at most once; a repeated day is refused. An empty list is refused. Omitting it fires on every day.
`minuteOfHour`	Minutes past the hour an hourly schedule fires. Defaults to 0.

dayOfWeek and daysOfWeek are different fields for different cadences. dayOfWeek is a single day and belongs to a weekly cadence, which fires on that one day. daysOfWeek is a list and belongs to an hourly or daily cadence, where it narrows an otherwise every-day schedule to the days you name. Neither field is accepted by the other’s cadence.

A created schedule reports nextScheduledAt.

Action

Field	Description
`flowIds`	Flows named one by one.
`tagNames`	Every flow carrying one of these tags. Combines with `flowIds`.
`kind`	`createSuite`, the default, runs the flows named by `flowIds` and `tagNames`. `generativeSuite` makes the trigger a Smart Smoke Suite: QA Wolf selects the flows from the pull request the deploy belongs to.
`instructions`	Optional guidance for a `generativeSuite` selection. Refused on a `createSuite` action.
`investigateFailures`	Whether QA Wolf investigates failures in the runs the trigger creates. Defaults to `true`.
`runConcurrencyLimit`	How many runs of the resulting suite may execute at once. Sent as a string: a whole number from 1 to 1000 such as `"40"`, the literal `"unlimited"`, or a concurrency expression such as `"max(2, 4)"`. A number or expression replaces the environment’s limit rather than capping below it, so it can raise the limit as well as lower it. `"unlimited"` is treated as unset, so the environment’s limit still applies. Omit it to leave the environment’s limit in charge.

An action names at least one flow or tag, or is a generativeSuite. A generativeSuite action:

Refuses flowIds and tagNames.
Is only valid on a deployment trigger.
Matches a deploy that isn’t tied to a pull request, but doesn’t run on it: the run outcome is did-not-run with reason no-pull-request. See PR testing for what ties a deploy to its pull request.

Paused

A paused trigger’s conditions aren’t checked. It still records a verdict for each deployment: not-considered, with reason trigger-paused. Resuming brings back the same configuration. A resumed schedule’s nextScheduledAt moves to its next upcoming slot, and slots missed while paused don’t run.

Flow conventions

@qawolf/flows

@qawolf/pom

@qawolf/testkit

@qawolf/emails

@qawolf/cli

Local execution

@qawolf/ci-sdk

Triggers

REST

Deployment conditions

Schedule

Action

Paused

​Deployment conditions

​Schedule

​Action

​Paused

Deployment conditions

Schedule

Action

Paused