Pipeline Syntax. Differences when considering top and stage level Agents

Pipeline Syntax. Differences when considering top and stage level Agents

Available Stage Options

Skip looking into rule from source control by standard within the agent directive. For instance: choices

Set a timeout duration with this phase, after which it Jenkins should abort the phase. For instance: choices

This stage the specified number of times on failure, retry. For instance: options

Prepend all system production generated in this phase with all the right time of which the line ended up being emitted. As an example: choices


The parameters directive provides a summary of parameters that a person should offer whenever triggering the Pipeline. The values for those user-specified parameters are distributed around Pipeline actions through the params object, begin to see the Parameters, Declarative Pipeline for the certain use.

Only one time, within the pipeline block.

Available Parameters

A parameter of the sequence kind, as an example: parameters

A text parameter, that could contain lines that are multiple as an example: parameters

A boolean parameter, as an example: parameters

A selection parameter, for instance: parameters

A password parameter, as an example: parameters

A list that is comprehensive of parameters is pending the conclusion of INFRA-1503.


The causes defines that are directive automated ways that the Pipeline should be re-triggered. For Pipelines that are incorporated with a supply such as for instance GitHub or BitBucket, triggers may possibly not be necessary as webhooks-based integration will most likely currently be there. The causes now available are cron , pollSCM and upstream .

Just once, within the pipeline block.

Accepts a string that is cron-style define a consistent period of which the Pipeline must be re-triggered.

Accepts a cron-style sequence to define a frequent period at which Jenkins should search for brand brand brand new supply modifications. If brand brand new modifications occur, the Pipeline will undoubtedly be re-triggered.

Accepts a comma-separated sequence of jobs and a limit. Whenever any working work within the sequence completes utilizing the minimum limit, the Pipeline will likely be re-triggered. As an example: causes

The pollSCM trigger is for sale in Jenkins 2.22 or later on.

Jenkins cron syntax

The syntax of this cron energy (with small distinctions). Specifically, each line consist of 5 industries divided by TAB or whitespace:

Minutes inside the full hour(0–59)

The hour of the(0–23 day)

The time associated with thirty days (1–31)

The thirty days (1–12)

The of the week (0–7) where 0 and 7 are Sunday day.

To specify multiple values for just one industry, the next operators can be obtained. In the near order of precedence,

* specifies all legitimate values

M-N specifies a variety of values

M-N/X or */X actions by periods of X through the specified range or entire range that is valid

A,B,…​,Z enumerates values that are multiple

To permit sporadically planned tasks to create even load on the machine, the expression H (for “hash”) must be utilized whenever we can. For instance, utilizing 0 0 * * * for a dozen day-to-day jobs can cause a big increase at midnight. In comparison, making use of H H * * * would nevertheless perform each work as soon as per day, not all during the time that is same better utilizing restricted resources.

The H icon could be regarded as a range, however it happens to be a hash associated with the work title, maybe not really title title loans in Arizona a random function, so the value continues to be stable for just about any offered task.


The stage directive goes into the phases part and may have a actions area, an agent that is optional, or any other stage-specific directives. Virtually talking, all the work that is real with a Pipeline should be wrapped in a number of phase directives.

One mandatory parameter, a sequence for the title associated with phase.

In the phases area.


A area defining tools to put and auto-install in the PATH . This is certainly ignored if representative none is specified.

In the pipeline block or perhaps a phase block.