Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc to access the /meta-data page of a build #2461

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add doc to access the /meta-data page of a build #2461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions pages/pipelines/build_meta_data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,15 @@ Assuming that the "release-version" key was set with the value from the Setting

## Using meta-data on the dashboard

Meta-data is not widely exposed in the Buildkite dashboard, but it can be added to most builds URLs to filter down the list of builds shown to only those with certain meta-data.
You can add `meta_data[…]=…` query parameters to most builds URLs to filter down the list of builds shown to only those with certain meta-data.

To list builds in a pipeline which have a "release-version" of "1.1" you could use:
For example, to list builds in a pipeline which have a "release-version" of "1.1" you can use:

https://buildkite.com/my-organization/my-pipeline/builds?meta_data[release-version]=1.1
https://buildkite.com/{my-organization}/{my-pipeline}/builds?meta_data[release-version]=1.1

You can also append `/meta-data` to the URL of a build to access a page that lists all the meta-data associated with that build:

https://buildkite.com/{my-organization}/{my-pipeline}/builds/{build-number}/meta-data

## Using meta-data in the REST API

Expand Down