Configure git checkout behavior. Pipeline-level values are inherited by each step unless that step overrides the same key. ssh_secret is step-level only and is not valid here
error("disallowed")
& matchN(0, [
null | bool | number | =~"^([Bb][Uu][Ii][Ll][Dd][Kk][Ii][Tt][Ee]|[Bb][Kk])" | [...] | {...}
]) &
strings.MinRunes(1) &
strings.MaxRunes(255) &
=~"^[A-Za-z][A-Za-z0-9_]*$"Name of an SSH private key secret from Buildkite Secrets to use for git clone/fetch operations. The name must start with a letter, contain only letters, numbers, and underscores, and must not start with `buildkite` or `bk` (case-insensitive).
Initialize, sync, update, and clean submodules recursively as part of checkout. An explicit null is treated as unset
Verify the checked-out commit is on the expected branch; strict fails the job on a definitive mismatch, warn only logs
Custom flags passed to git commands during checkout. Flag strings are passed to git verbatim and are not sanitized; do not interpolate untrusted input. See the agent documentation for precedence and defaults: https://buildkite.com/docs/agent/v3/configuration
Flags for the git checkout command
Check out only the specified paths in git cone mode; requires git 2.27+ on the agent
Query rules to target specific agents in k=v format
Query rules to target specific agents
Whether to proceed with this step and further steps if a step named in the depends_on attribute fails
A list of teams that are permitted to unblock this step, whose values are a list of one or more team slugs or IDs
The exit status number that will cause this job to retry
"*" | "none" | "agent_incompatible" | "agent_refused" | "agent_stop" | "cancel" | "process_run_error" | "signature_rejected" | "stack_error"
The exit signal reason, if any, that may be retried
The exit status number that will cause this job to retry
The number of times this job can be retried
The exit signal, if any, that may be retried
"*" | "none" | "agent_incompatible" | "agent_refused" | "agent_stop" | "cancel" | "process_run_error" | "signature_rejected" | "stack_error"
The exit signal reason, if any, that may be retried
The state that the build is set to when the build is blocked by this block step
[ ...matchN(1, [ #notifySimple, #notifyEmail, #notifyBasecamp, #notifySlack, #notifyWebhook, #notifyPagerduty, #notifyGithubCommitStatus, #notifyGithubCheck, ]) ]
Array of notification options for this step
matchN(1, [ #notifySimple, #notifyEmail, #notifyBasecamp, #notifySlack, #notifyWebhook, #notifyPagerduty, #notifyGithubCommitStatus, #notifyGithubCheck, ])
Whether to cancel the job as soon as the build is marked as failing
Configure git checkout behavior. Pipeline-level values are inherited by each step unless that step overrides the same key
Initialize, sync, update, and clean submodules recursively as part of checkout. An explicit null is treated as unset
Verify the checked-out commit is on the expected branch; strict fails the job on a definitive mismatch, warn only logs
Custom flags passed to git commands during checkout. Flag strings are passed to git verbatim and are not sanitized; do not interpolate untrusted input. See the agent documentation for precedence and defaults: https://buildkite.com/docs/agent/v3/configuration
Flags for the git checkout command
matchN(0, [
null | bool | number | =~"^([Bb][Uu][Ii][Ll][Dd][Kk][Ii][Tt][Ee]|[Bb][Kk])" | [...] | {...}
]) &
strings.MinRunes(1) &
strings.MaxRunes(255) &
=~"^[A-Za-z][A-Za-z0-9_]*$"Name of an SSH private key secret from Buildkite Secrets to use for git clone/fetch operations. The name must start with a letter, contain only letters, numbers, and underscores, and must not start with `buildkite` or `bk` (case-insensitive).
Check out only the specified paths in git cone mode; requires git 2.27+ on the agent
matchN(0, [
null |
bool |
number |
=~"^[-\\t\\n\\v\\f\\r \u0085\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]|[\\t\\n\\v\\f\\r \u0085\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]$" |
[...] |
{...}
]) &
=~"^[^,\\t\\n\\v\\f\\r]+$"The glob path/s of artifacts to upload once this step has finished running
Initialize, sync, update, and clean submodules recursively as part of checkout. An explicit null is treated as unset
Verify the checked-out commit is on the expected branch; strict fails the job on a definitive mismatch, warn only logs
Custom flags passed to git commands during checkout. Flag strings are passed to git verbatim and are not sanitized; do not interpolate untrusted input. See the agent documentation for precedence and defaults: https://buildkite.com/docs/agent/v3/configuration
Flags for the git checkout command
matchN(0, [
null | bool | number | =~"^([Bb][Uu][Ii][Ll][Dd][Kk][Ii][Tt][Ee]|[Bb][Kk])" | [...] | {...}
]) &
strings.MinRunes(1) &
strings.MaxRunes(255) &
=~"^[A-Za-z][A-Za-z0-9_]*$"Name of an SSH private key secret from Buildkite Secrets to use for git clone/fetch operations. The name must start with a letter, contain only letters, numbers, and underscores, and must not start with `buildkite` or `bk` (case-insensitive).
Check out only the specified paths in git cone mode; requires git 2.27+ on the agent
The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define concurrency_group.
A unique name for the concurrency group that you are creating with the concurrency attribute
Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.
The signature of the command step, generally injected by agents at pipeline upload
The algorithm used to generate the signature
The fields that were signed to form the signature value
The number of parallel jobs that will be created based on this step
The number of minutes to time out a job
Whether to allow a job to retry automatically. If set to true, the retry conditions are set to the default value.
The commands to run on the agent
Whether to allow a job to be retried manually
Whether or not this job can be retried manually
Whether or not this job can be retried after it has passed
Array of notification options for this step
The step keys for a step to depend on
[_, ...] & [ ...matchN(>=1, [ #blockStep, #nestedBlockStep, #stringBlockStep, #inputStep, #nestedInputStep, #stringInputStep, #commandStep, #nestedCommandStep, #waitStep, #nestedWaitStep, #stringWaitStep, #triggerStep, #nestedTriggerStep, ]) ]
matchN(1, [
string,
[...string], close({
// Pattern or list of patterns to include
"include"!: matchN(1, [string, [...string]])
// Pattern or list of patterns to exclude
"exclude"?: matchN(1, [string, [...string]])
}),
])Agent-applied attribute: A glob pattern that omits the step from a build if it does not match any files changed in the build. Can be a single pattern, list of patterns, or an object with include/exclude attributes.
The state that the build is set to when the build is blocked by this input step
Specification of a new or existing Build Matrix combination
List of elements for single-dimension Build Matrix
Configuration for multi-dimension Build Matrix
List of Build Matrix adjustments
The state that the build is set to when the build is blocked by this block step
The glob path/s of artifacts to upload once this step has finished running
Initialize, sync, update, and clean submodules recursively as part of checkout. An explicit null is treated as unset
Verify the checked-out commit is on the expected branch; strict fails the job on a definitive mismatch, warn only logs
Custom flags passed to git commands during checkout. Flag strings are passed to git verbatim and are not sanitized; do not interpolate untrusted input. See the agent documentation for precedence and defaults: https://buildkite.com/docs/agent/v3/configuration
Flags for the git checkout command
matchN(0, [
null | bool | number | =~"^([Bb][Uu][Ii][Ll][Dd][Kk][Ii][Tt][Ee]|[Bb][Kk])" | [...] | {...}
]) &
strings.MinRunes(1) &
strings.MaxRunes(255) &
=~"^[A-Za-z][A-Za-z0-9_]*$"Name of an SSH private key secret from Buildkite Secrets to use for git clone/fetch operations. The name must start with a letter, contain only letters, numbers, and underscores, and must not start with `buildkite` or `bk` (case-insensitive).
Check out only the specified paths in git cone mode; requires git 2.27+ on the agent
The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define concurrency_group.
A unique name for the concurrency group that you are creating with the concurrency attribute
Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.
The signature of the command step, generally injected by agents at pipeline upload
The algorithm used to generate the signature
The fields that were signed to form the signature value
The number of parallel jobs that will be created based on this step
The number of minutes to time out a job
The glob path/s of artifacts to upload once this step has finished running
Initialize, sync, update, and clean submodules recursively as part of checkout. An explicit null is treated as unset
Verify the checked-out commit is on the expected branch; strict fails the job on a definitive mismatch, warn only logs
Custom flags passed to git commands during checkout. Flag strings are passed to git verbatim and are not sanitized; do not interpolate untrusted input. See the agent documentation for precedence and defaults: https://buildkite.com/docs/agent/v3/configuration
Flags for the git checkout command
matchN(0, [
null | bool | number | =~"^([Bb][Uu][Ii][Ll][Dd][Kk][Ii][Tt][Ee]|[Bb][Kk])" | [...] | {...}
]) &
strings.MinRunes(1) &
strings.MaxRunes(255) &
=~"^[A-Za-z][A-Za-z0-9_]*$"Name of an SSH private key secret from Buildkite Secrets to use for git clone/fetch operations. The name must start with a letter, contain only letters, numbers, and underscores, and must not start with `buildkite` or `bk` (case-insensitive).
Check out only the specified paths in git cone mode; requires git 2.27+ on the agent
The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define concurrency_group.
A unique name for the concurrency group that you are creating with the concurrency attribute
Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.
The signature of the command step, generally injected by agents at pipeline upload
The algorithm used to generate the signature
The fields that were signed to form the signature value
The number of parallel jobs that will be created based on this step
The number of minutes to time out a job
The glob path/s of artifacts to upload once this step has finished running
Initialize, sync, update, and clean submodules recursively as part of checkout. An explicit null is treated as unset
Verify the checked-out commit is on the expected branch; strict fails the job on a definitive mismatch, warn only logs
Custom flags passed to git commands during checkout. Flag strings are passed to git verbatim and are not sanitized; do not interpolate untrusted input. See the agent documentation for precedence and defaults: https://buildkite.com/docs/agent/v3/configuration
Flags for the git checkout command
matchN(0, [
null | bool | number | =~"^([Bb][Uu][Ii][Ll][Dd][Kk][Ii][Tt][Ee]|[Bb][Kk])" | [...] | {...}
]) &
strings.MinRunes(1) &
strings.MaxRunes(255) &
=~"^[A-Za-z][A-Za-z0-9_]*$"Name of an SSH private key secret from Buildkite Secrets to use for git clone/fetch operations. The name must start with a letter, contain only letters, numbers, and underscores, and must not start with `buildkite` or `bk` (case-insensitive).
Check out only the specified paths in git cone mode; requires git 2.27+ on the agent
The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define concurrency_group.
A unique name for the concurrency group that you are creating with the concurrency attribute
Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.
The signature of the command step, generally injected by agents at pipeline upload
The algorithm used to generate the signature
The fields that were signed to form the signature value
The number of parallel jobs that will be created based on this step
The number of minutes to time out a job
The state that the build is set to when the build is blocked by this input step
The slug of the pipeline to create a build
Continue to the next steps, even if the previous group of steps fail
Continue to the next steps, even if the previous group of steps fail
The summary of the GitHub check's output
[...close({
// The path of the file to add an annotation to, relative to the repository root
"path"!: string
// The start line of the annotation
"start_line"!: int
// The end line of the annotation
"end_line"!: int
// The start column of the annotation. Only valid when start_line and end_line are equal
"start_column"?: int
// The end column of the annotation. Only valid when start_line and end_line are equal
"end_column"?: int
// The level of the annotation
"annotation_level"!: "notice" | "warning" | "failure"
// The message for the annotation
"message"!: string
// The title for the annotation
"title"?: string
// Additional details for the annotation, displayed alongside the message
"raw_details"?: string
})]The path of the file to add an annotation to, relative to the repository root
The start line of the annotation
The end line of the annotation
The start column of the annotation. Only valid when start_line and end_line are equal
The end column of the annotation. Only valid when start_line and end_line are equal
The level of the annotation
The message for the annotation
The title for the annotation
Additional details for the annotation, displayed alongside the message
GitHub commit status name
[ ...matchN(>=1, [ #blockStep, #nestedBlockStep, #stringBlockStep, #inputStep, #nestedInputStep, #stringInputStep, #commandStep, #nestedCommandStep, #waitStep, #nestedWaitStep, #stringWaitStep, #triggerStep, #nestedTriggerStep, #groupStep, ]) ]
A list of steps
matchN(>=1, [ #blockStep, #nestedBlockStep, #stringBlockStep, #inputStep, #nestedInputStep, #stringInputStep, #commandStep, #nestedCommandStep, #waitStep, #nestedWaitStep, #stringWaitStep, #triggerStep, #nestedTriggerStep, #groupStep, ])
Array of plugins for this step
A map of plugins for this step. Deprecated: please use the array syntax.
The value of the option(s) that will be pre-selected in the dropdown
Whether more than one option may be selected
The text displayed on the select list item
The value to be stored as meta-data
The text displayed directly under the select field’s label
Whether the field is required for form submission
Whether the field is required for form submission
The exit status number that will cause this job to soft-fail
Pauses the execution of a build and waits on a user to unblock it
Pauses the execution of a build and waits on a user to unblock it
Waits for previous steps to pass before continuing
Whether the field is required for form submission
The value that is pre-filled in the text field
The slug of the pipeline to create a build
Continue to the next steps, even if the previous group of steps fail
JSON schema for Buildkite pipeline configuration files