buildkite-agent job

The Buildkite agent's job update command provides the ability to update the attributes of a job.

Updating a job

Use this command in your build scripts to update a job's attributes. Only command jobs can be updated and must not have finished.

Currently, only the timeout_in_minutes attribute can be updated.

timeout_in_minutes (alias timeout): The maximum number of minutes this step is allowed to run, relative to the job's start time. If the job exceeds this time limit, the job is automatically canceled and the build fails. Jobs that time out with an exit status of 0 are marked as passed. See Updating timeouts during a job for more information.

Usage

buildkite-agent job update <attribute> <value> [options...]

Description

Update an attribute of a job. Only command jobs can be updated, and only before they are finished.

Example

$ buildkite-agent job update timeout 20
$ echo 20 | buildkite-agent job update timeout

Options

--no-color #

Don't show colors in logging (default: false)
Environment variable: $BUILDKITE_AGENT_NO_COLOR

--debug #

Enable debug mode. Synonym for `--log-level debug`. Takes precedence over `--log-level` (default: false)
Environment variable: $BUILDKITE_AGENT_DEBUG

--log-level value #

Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice")
Environment variable: $BUILDKITE_AGENT_LOG_LEVEL

--experiment value #

Enable experimental features within the buildkite-agent
Environment variable: $BUILDKITE_AGENT_EXPERIMENT

--profile value #

Enable a profiling mode, either cpu, memory, mutex or block
Environment variable: $BUILDKITE_AGENT_PROFILE

--agent-access-token value #

The access token used to identify the agent
Environment variable: $BUILDKITE_AGENT_ACCESS_TOKEN

--endpoint value #

The Agent API endpoint (default: "https://agent.buildkite.com/v3")
Environment variable: $BUILDKITE_AGENT_ENDPOINT

--no-http2 #

Disable HTTP2 when communicating with the Agent API (default: false)
Environment variable: $BUILDKITE_NO_HTTP2

--debug-http #

Enable HTTP debug mode, which dumps all request and response bodies to the log (default: false)
Environment variable: $BUILDKITE_AGENT_DEBUG_HTTP

--trace-http #

Enable HTTP trace mode, which logs timings for each HTTP request. Timings are logged at the debug level unless a request fails at the network level in which case they are logged at the error level (default: false)
Environment variable: $BUILDKITE_AGENT_TRACE_HTTP

--job value #

The job to update. Defaults to the current job
Environment variable: $BUILDKITE_JOB_ID

--redacted-vars value #

Pattern of environment variable names containing sensitive values (default: "*_PASSWORD", "*_SECRET", "*_TOKEN", "*_PRIVATE_KEY", "*_ACCESS_KEY", "*_SECRET_KEY", "*_CONNECTION_STRING")
Environment variable: $BUILDKITE_REDACTED_VARS