This appears to be in conflict with the API and the docs https://buildkite.com/docs/pipelines/trigger-step

Hi buildkite,

According to the schema, plugins should be an array of objects. However, in practice, buildkite happily accepted a pipeline with the following syntax:

    plugins:
      - ssh://[email protected]/bkpl/namespace.git
      - docker-compose:
          run: k6-pipeline
          command: ["run", "tests/creditCardMakePayment.js"]
          config:
            - ./loadtesting/k6/docker-compose.yml

Note that the first item in the plugins array is of type string, not object.

Can we update the schema to reflect what we have in prod? Thanks!

Buildkite has been gradually renaming default branches from master to main.

The JSON Schema Store entry for Buildkite references the master branch of this repo:
https://raw.githubusercontent.com/buildkite/pipeline-schema/master/schema.json

I'll aim to get that changed ASAP, and GitHub might redirect and/or cache the existing URL in the mean time.

I'm going to rename the branch, and use this issue to track any other actions or problems that arise.

See buildkite/docs#1087 for docs

This was added as a valid keyword on jobs a few weeks ago, but the schema doesn't include it yet, so my VSCode schema validator claims that it's invalid. :(

buildkite yaml like this

  - group: "Optional branch deploys"
    steps:
      - input: "Release to personal staging?"
        depends_on: "build-node-modules"

Produces an error in vscode Property input is not allowed. yaml-schema: buildkite

Looks similar to this issue that was fixed #8 - probably need to do someting similar for groups

I can confirm the code I gave above does indeed work.

Hi,

Thanks for the schema json! It has been a life saver!
However, at the moment I need to manually copy the schema.json into our solution.

The use case is simple:
We have a monorepo and we need to dynamically generate the buildkite pipeline and we built a node.js tool to do so. Having the schema allow us to validate the generated pipeline via unit test.
Hence, it would be very useful to have a library with a proper version so it can be detected by npm/yarn tools and we can update the schema when buildkite does instead of manually tracking the changes.

No guidelines for contribution or process for getting PRs approved.

I'm unsure if this is something that comes up as invalid based on the schema, or if this is because the schema validation plugin I'm using in VSCode doesn't know how to deal with them, but our BuildKite pipelines use a lot of YAML named anchors, and they all appear as invalid, as below:

Is this something that can be fixed in the schema, or is this a bug for the plugin?

When provide array string to fieldss default, vs code shows warning
E.g

  - block: "Deploy to QA"
    fields:
      - select: "Regions"
        key: "deploy-regions"
        hint: "Which regions should we deploy this to? :earth_asia:"
        multiple: true
        default: ["ap-southeast-2", "eu-west-1"]
        options:
          - label: "Sydney"
            value: "ap-southeast-2"
          - label: "Ireland"
            value: "eu-west-1"

Error

Consider the following example pipeline with duplicate step keys:

---
steps:
- key: my_duplicate_step_key
  label: ":bash: Hello World One"
  agents:
    queue: my-queue
  command: echo "hello world"
- key: my_duplicate_step_key
  label: ":bash: Hello World Two"
  agents:
    queue: my-queue
  command: echo "hello world again"

Validating this pipeline against the schema does not raise any issues.

However, when attempting to upload the pipeline to Buildkite, an error will be presented:

Failed to upload and process pipeline: Pipeline upload rejected: 
The key "my_duplicate_step_key" has already been used by another step in this build

Hello BuildKite,

Schema.json is missing a comma. Please add a comma in here:

Regards,
Kelvin

According to the docs the group field is allowed to be null but in the schema it appears to be non-nullable.

See buildkite/docs#1123 for docs on this

input steps (https://buildkite.com/docs/pipelines/input-step) are shown in VSCode with this message 'Property input is not allowed.'
It looks like the input step is missing from the schema. Could you add support for it, please?
The documentation makes it sounds like the schema for input and block would be the same. If that's the case, I'd happily do a PR.

Per https://buildkite.com/docs/pipelines/group-step#group-step-attributes GroupStep should support a depends_on field, but I'm not seeing it in the schema :D

Thanks!

As defined here, https://buildkite.com/docs/pipelines/command-step#command-step-attributes

👋 hello!

groupStep is missing the if attribute.

With the following pipeline,

steps:
  - group: ":terraform: Staging Terraform"
    key: "staging-terraform"
    steps:
      - block: ":rocket: Release!"
        branches: $BUILDKITE_PIPELINE_DEFAULT_BRANCH
        key: wait-release-confirmation
        depends_on: start-gate

when checking with the current schema, I got the following error:

Schema validation errors were encountered.
  pipeline.yml::$.steps[0]: {'group': ':terraform: Staging Terraform', 'key': 'staging-terraform', 'steps': [{'block': ':rocket: Release!', 'branches': '$BUILDKITE_PIPELINE_DEFAULT_BRANCH', 'key': 'wait-release-confirmation', 'depends_on': 'start-gate'}]} is not valid under any of the given schemas
  Underlying errors caused this.
  Best Match:
    $.steps[0]: Additional properties are not allowed ('steps', 'group' were unexpected)

while Buildkite has no issue to read it.

This issue prevent us to apply the schema as pre-commit hook.

Is concurrency_method step field a valid one? You can pass it to buildkite, and it is mentioned in the example here. But it's not otherwise documented and it's not in the schema itself.

Problem

Using a conditional in a pipeline.yml file causes validation to fail with the following message: Property if is not allowed.. Shown here using the example from the Buildkite documentation, Using Conditionals:

Suspected Cause

It appears as though the schema does not currently support the if property. The schema.json does not have any attribute "if" within the commandStep.

Conditional properties were introduced approximately three months ago, so it seems likely that the schema simply has not yet been updated.

Suggested Fix

It seems likely that the fix will be similar to that in #4. This case may be simpler, as the documentation indicates only strings are supported by this property.

Being able to reference a specific version of the repo would be helpful. So far, the only reference would be a commit hash.

When creating a step, values with underscores are allowed when using the key attribute.
This is confirmed by buildkite/feedback#424

In the schema json, the pattern for key does not explicitly support underscores.

Should the schema's pattern explicitly support underscores in the key attribute?

https://buildkite.com/docs/integrations/github#customizing-commit-statuses-step-level

Using schema from "https://raw.githubusercontent.com/buildkite/pipeline-schema/master/schema.json"

I ran into an issue when my build pipeline accidentally included a named step that lacked a command or other body. I whittled it down to this MWE:

# .buildkite/pipeline.yml
---
steps:
  - name: foo

I use buildkite-signed-pipeline, and what it shows me is the following:

~~~ Running commands
$ trap 'kill -- $$' INT TERM QUIT; buildkite-signed-pipeline upload
2023/10/31 02:19:03 Using secret from AWS SM arn:aws:secretsmanager:us-east-2:123:secret:/buildkite-agent/non-production/signed_pipeline-xyz
2023/10/31 02:19:03 $ buildkite-agent pipeline upload --dry-run
2023-10-31 02:19:03 INFO   Searching for pipeline config...
2023-10-31 02:19:03 INFO   Found config file ".buildkite/pipeline.yml"
2023-10-31 02:19:03 INFO   Updating BUILDKITE_COMMIT to "d34db33f"
2023-10-31 02:19:03 INFO   Reading pipeline config from STDIN
2023-10-31 02:19:04 ERROR  Unrecoverable error, skipping retries
2023-10-31 02:19:04 FATAL  Failed to upload and process pipeline: Pipeline upload rejected: Step is missing a type `{"name":"foo"}`
2023/10/31 02:19:04 exit status 1

I thought i'd be clever and introduce a JSON schema validation step using the jv tool, however it seems that your JSON schema doesn't prohibit the situation i describe:

$ jv -output detailed https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json ./.buildkite/pipeline.yml
{
  "valid": true
}

Is this behaviour expected? I would think the JSON schema should reject a pipeline the API will reject.

I see that global agents can be specified like this:

agents: # <-- This one.
  os: ubuntu
  queue: default

steps:
  - command: echo "1"
  ...

However, current schema dıoes not show agents like above as a valid and does not autocomplete on VSCode.

See: https://forum.buildkite.community/t/setting-default-agents-for-a-build/111/3