Module: Buildkit::Client::Jobs

Included in:

Buildkit::Client

Defined in:

lib/buildkit/client/jobs.rb

Overview

Methods for the Jobs API

See Also:

• https://buildkite.com/docs/rest-api/jobs

Instance Method Summary

• #job_env(org, pipeline, build, job, options = {}) ⇒ Array<Sawyer::Resource>

  Get a job’s environment variables.

• #retry_job(org, pipeline, build, job, options = {}) ⇒ Array<Sawyer::Resource>

  Retry a job.

Instance Method Details

#job_env(org, pipeline, build, job, options = {}) ⇒ Array<Sawyer::Resource>

Get a job’s environment variables

Examples:

Buildkit.job_env('my-great-org', 'great-pipeline', 123, 'my-job-id')

Parameters:

• org (String) —

  Organization slug.

• pipeline (String) —

  Pipeline slug.

• build (Integer) —

  Build number.

• job (String) —

  Job id.

Returns:

• (Array<Sawyer::Resource>) —

  Hashes representing Buildkite job env.

See Also:

• https://buildkite.com/docs/rest-api/jobs#get-a-jobs-environment-variables

# File 'lib/buildkit/client/jobs.rb', line 31

def job_env(org, pipeline, build, job, options = {})
  get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/env", options)
end

#retry_job(org, pipeline, build, job, options = {}) ⇒ Array<Sawyer::Resource>

Retry a job

Examples:

Buildkit.retry_job('my-great-org', 'great-pipeline', 123, 'my-job-id')

Parameters:

• org (String) —

  Organization slug.

• pipeline (String) —

  Pipeline slug.

• build (Integer) —

  Build number.

• job (String) —

  Job id.

Returns:

• (Array<Sawyer::Resource>) —

  Hashes representing Buildkite job.

See Also:

• https://buildkite.com/docs/rest-api/jobs#retry-a-job

# File 'lib/buildkit/client/jobs.rb', line 17

def retry_job(org, pipeline, build, job, options = {})
  put("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/retry", options)
end