name |
- The name of the pipeline. Example: |
-
|---|---|
cluster_id |
- The ID value of the cluster the pipeline will be associated with. Example: |
-
repository |
- The repository URL. Example: |
-
configuration |
-
- The YAML pipeline that consists of the build pipeline steps. Example: |
-
name |
+
+ The name of the pipeline. +Example: |
+
cluster_id |
+
+ The ID value of the cluster the pipeline will be associated with. +Example: |
+
repository |
+
+ The repository URL. +Example: |
+
configuration |
+
+ The YAML pipeline that consists of the build pipeline steps. +Example: |
+
cluster_idnull to remove the pipeline from a cluster.Example: "42f1a7da-812d-4430-93d8-1cc7c33a6bcf"
The ID of the cluster the pipeline should run in. Set to null to remove the pipeline from a cluster.
Example: "42f1a7da-812d-4430-93d8-1cc7c33a6bcf"
default_branchpipeline_template_uuidnull to remove the pipeline template from the pipeline.Example: "018e5a22-d14c-7085-bb28-db0f83f43a1c"
The UUID of the pipeline template the pipeline should run with. Set to null to remove the pipeline template from the pipeline.
Example: "018e5a22-d14c-7085-bb28-db0f83f43a1c"
provider_settingsslugA custom identifier for the pipeline. If provided, this slug will be used as the pipeline's URL path instead of automatically converting the pipeline name. If the value is null, the pipeline name will be used to generate the slug.
Example: "slug": "my-custom-pipeline-slug"
Example: "my-custom-pipeline-slug"
visibilityWhether the pipeline is visible to everyone, including users outside this organization.
Example: "public"
Default: "private"
Whether the pipeline is visible to everyone, including users outside this organization.
+Example: "public"
Default: "private"
nameExample: "New Pipeline"
The name of the pipeline.
+Example: "New Pipeline"
cluster_idExample: "Ab1Cd2Ef3Gh4Ij5Kl6Mn7Op8Qr9St0Uv10Wx11Yz12Ab1Cd2Ef3Gh4Ij5Kl6Mn=="
The ID value of the cluster the pipeline will be associated with.
+Example: "Ab1Cd2Ef3Gh4Ij5Kl6Mn7Op8Qr9St0Uv10Wx11Yz12Ab1Cd2Ef3Gh4Ij5Kl6Mn=="
repositoryExample: "git@github.com:acme-inc/my-pipeline.git"
The repository URL.
+Example: "git@github.com:acme-inc/my-pipeline.git"
stepsScript: { "type": "script", "name": "Script", "command": "command.sh" }
Wait for all previous steps to finish: { "type": "waiter" }
Block pipeline (see the job unblock API): { "type": "manual" }
+
An array of the build pipeline steps.
+Script: { "type": "script", "name": "Script", "command": "command.sh" }
Wait for all previous steps to finish: { "type": "waiter" }
Block pipeline (see the job unblock API): { "type": "manual" }
cluster_idnull to remove the pipeline from a cluster.Example: "42f1a7da-812d-4430-93d8-1cc7c33a6bcf"
The ID of the cluster the pipeline should run in. Set to null to remove the pipeline from a cluster.
Example: "42f1a7da-812d-4430-93d8-1cc7c33a6bcf"
default_branchpipeline_template_uuidnull to remove the pipeline template from the pipeline.Example: "018e5a22-d14c-7085-bb28-db0f83f43a1c"
The UUID of the pipeline template the pipeline should run with. Set to null to remove the pipeline template from the pipeline.
Example: "018e5a22-d14c-7085-bb28-db0f83f43a1c"
provider_settingsbranch_configurationExample: "main feature/*"
Default: null
A branch filter pattern to limit which pushed branches trigger builds on this pipeline.
+Example: "main feature/*"
Default: null
cancel_running_branch_buildsExample: true
Default: false
Cancel intermediate builds. When a new build is created on a branch, any previous builds that are running on the same branch will be automatically canceled.
+Example: true
Default: false
cancel_running_branch_builds_filterExample: "develop prs/*"
Default: null
A branch filter pattern to limit which branches intermediate build canceling applies to.
+Example: "develop prs/*"
Default: null
cluster_idnull to remove the pipeline from a cluster.Example: "42f1a7da-812d-4430-93d8-1cc7c33a6bcf"
The ID of the cluster the pipeline should run in. Set to null to remove the pipeline from a cluster.
Example: "42f1a7da-812d-4430-93d8-1cc7c33a6bcf"
configurationExample: "steps:\n - command: \"new.sh\"\n agents:\n - \"myqueue=true\""
The YAML pipeline that consists of the build pipeline steps.
+Example: "steps:\n - command: \"new.sh\"\n agents:\n - \"myqueue=true\""
default_branchThe name of the branch to prefill when new builds are created or triggered in Buildkite.
Example: "main"
descriptionExample: "\:package\: A testing pipeline"
The pipeline description.
+Example: "\:package\: A testing pipeline"
envExample: {"KEY":"value"}
The pipeline environment variables.
+Example: {"KEY":"value"}
nameExample: "New Pipeline"
The name of the pipeline. If you provide a new name without a slug parameter, the slug will be automatically updated to match the new name.
Example: "New Pipeline"
pipeline_template_uuidnull to remove the pipeline template from the pipeline.Example: "018e5a22-d14c-7085-bb28-db0f83f43a1c"
The UUID of the pipeline template the pipeline should run with. Set to null to remove the pipeline template from the pipeline.
Example: "018e5a22-d14c-7085-bb28-db0f83f43a1c"
provider_settingsExample: { "publish_commit_status": true, "build_pull_request_forks": true }
The source provider settings. See the Provider Settings section for accepted properties.
+Example: { "publish_commit_status": true, "build_pull_request_forks": true }
repositoryExample: "git@github.com/org/repo.git"
The repository URL.
+Example: "git@github.com/org/repo.git"
skip_queued_branch_buildsExample: true
Default: false
Skip intermediate builds. When a new build is created on a branch, any previous builds that haven't yet started on the same branch will be automatically marked as skipped.
+Example: true
Default: false
skip_queued_branch_builds_filterExample: "!main"
Default: null
A branch filter pattern to limit which branches intermediate build skipping applies to.
+Example: "!main"
Default: null
slugA custom identifier for the pipeline. This slug will be used as the pipeline's URL path. If not provided when the pipeline name is updated, the slug will be automatically generated from the new pipeline name. If the pipeline name is not updated, the existing slug will remain unchanged.
+Example: "my-custom-pipeline-slug"
tagsvisibilityExample: "public"
Default: "private"
Whether the pipeline is visible to everyone, including users outside this organization.
+Example: "public"
Default: "private"
filter_enabledWhether filter conditions are used for this pipeline.
Values: true, false
filter_conditionThe conditions under which this pipeline will trigger a build. See the Using conditionals guide for more information.
Example: "build.pull_request.base_branch =~ /main/"
build_branchesValues: true, false
Whether to create builds when branches are pushed.
+Values: true, false
build_pull_requestsValues: true, false
Whether to create builds for commits that are part of a Pull Request.
+Values: true, false
build_tagsValues: true, false
Whether to create builds when tags are pushed.
+Values: true, false
build_branchesWhether to create builds when branches are pushed.
Values: true, false
build_pull_requestsWhether to create builds for commits that are part of a Pull Request.
Values: true, false
build_tagsValues: true, false
Whether to create builds when tags are pushed.
+Values: true, false
cancel_deleted_branch_buildsValues: true, false
A boolean to enable automatically cancelling any running builds for a branch if the branch is deleted.
+Values: true, false
publish_commit_statusValues: true, false
Whether to update the status of commits in Bitbucket or GitHub.
+Values: true, false
publish_commit_status_per_stepValues: true, false
Whether to create a separate status for each job in a build, allowing you to see the status of each job directly in Bitbucket or GitHub.
+Values: true, false
pull_request_branch_filter_enabledWhether to limit the creation of builds to specific branches or patterns.
Values: true, false
pull_request_branch_filter_configurationThe branch filtering pattern. Only pull requests on branches matching this pattern will cause builds to be created.
Example: "features/*"
skip_builds_for_existing_commitsValues: true, false
Whether to skip creating a new build if a build for the commit and branch already exists.
+Values: true, false
skip_pull_request_builds_for_existing_commitsValues: true, false
Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists.
+Values: true, false
build_pull_request_forksValues: true, false
Whether to create builds for pull requests from third-party forks.
+Values: true, false
build_pull_request_labels_changedValues: true, false
Whether to create builds for pull requests when labels are added or removed.
+Values: true, false
build_pull_request_ready_for_reviewValues: true, false
Whether to create builds for pull requests that are ready for review.
+Values: true, false
prefix_pull_request_fork_branch_namesmain branch from some-user will become some-user:main.
- Values: true, false
Prefix branch names for third-party fork builds to ensure they don't trigger branch conditions. For example, the main branch from some-user will become some-user:main.
Values: true, false
publish_blocked_as_pendingPending can be used with required status checks to prevent merging pull requests with blocked builds.
- Values: true, false
The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
Values: true, false
separate_pull_request_statusesValues: true, false
Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your required status checks in GitHub.
+Values: true, false
trigger_modecode creates builds when code is pushed to GitHub.deployment creates builds when a deployment is created with the GitHub Deployments API.fork creates builds when the GitHub repository is forked.none will not create any builds based on GitHub activity.Values: code, deployment, fork, none
What type of event to trigger builds on. +
code creates builds when code is pushed to GitHub.deployment creates builds when a deployment is created with the GitHub Deployments API.fork creates builds when the GitHub repository is forked.none will not create any builds based on GitHub activity.Values: code, deployment, fork, none