Configure Secrets in BuildKite: Create a Trunk API Key and add it to BuildKite's secret store named TRUNK_API_TOKEN
Setup OpenTelemetry Export from BuildKite: Provides span data to the Dynamic CI system so we can learn about your pipelines and jobs. Configure BuildKite to export CI data to Trunk
Paste a BuildKite API token into Settings → Organization → Buildkite. Use a token from a dedicated BuildKite user.
read_buildswrite_buildsread_pipelinesread_organizations
Give your steps keys
Add akey: to every step you might want skipped. A step without one always
runs.
Add the plugin to your upload step
Pipe your pipeline through the filter on its way to upload. Your repository starts in Learning mode, so Trunk records a verdict for every step and skips nothing until you turn on enforcement.- Pin an exact release, v0.1.3 or later.
- Don’t pass
--no-interpolationtobuildkite-agent pipeline upload. trigger:steps are never skipped. Aparallelism:step runs or skips as a whole. So does amatrix:step, unless you decide it by variation.
Mark steps that must never be skipped
Trunk can’t tell which Buildkite steps are required to merge. Before you turn on enforcement, list them inexclude-keys:
Run it beside your pipeline (dry run)
Run it beside your pipeline (dry run)
if: and agents: as your other pull request steps. Move to
the upload step before you turn on enforcement.Pipelines with no upload step (step mode)
Pipelines with no upload step (step mode)
mode: step. The step needs a key:. It saves less,
because the agent has already started, and a skipped step reports as passed.Send your build tool's impact (v0.1.8 or later)
Send your build tool's impact (v0.1.8 or later)
source: your name for the measure (lowercase letters, digits,.,_,-). Keep it the same on every build.count: a whole number. Send0when nothing is affected.all: truein place ofcountwhen everything is affected.
All options
All options
Matrix steps
Amatrix: step runs or skips as a whole unless you
decide it by variation. Once you have,
nothing in your pipeline changes beyond the plugin, which must be v0.1.9 or
later. When Trunk skips some variations of a step, the plugin leaves them out
of the step it uploads, and the upload step’s log counts them.
- A matrix with no dimension names (
matrix: [amd64, arm64]): the skipped values are removed from the list. - A matrix with named dimensions (
setup: {os: [...], arch: [...]}): amatrix.adjustmentsentry withskip:is added for each skipped variation. Buildkite allows 12 adjustments per step, counting your own; when a build would need more, every variation of that step runs.
setup whose dimension is named "" is always
decided as a whole. The plugin sends your matrix values to Trunk with
environment variables filled in, so don’t put a secret in a matrix value.
Troubleshooting
Setdebug: true to print what the plugin asked for and the plan it got back.
- Nothing is skipped. Check the repository is Enforced, the steps have a
key:, and Trunk has a couple of days of builds for them. - The plan request returns 404. The pipeline’s remote doesn’t match a repository in your Trunk organization with CI data.
baseShais null on a pull request build. Fetch the target branch before the upload step.