Module: Buildkit::Client::Artifacts

Included in:

Buildkit::Client

Defined in:

lib/buildkit/client/artifacts.rb

Overview

Methods for the Artifacts API

See Also:

• https://buildkite.com/docs/api/artifacts

Instance Method Summary

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

  List all artifacts for a build.

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

  List all artifacts for a job.

Instance Method Details

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

List all artifacts for a build

Examples:

Buildkit.artifacts('my-great-org', 'great-pipeline', 42)

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite artifacts.

See Also:

• https://buildkite.com/docs/api/artifacts#list-all-artifacts

# File 'lib/buildkit/client/artifacts.rb', line 15

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

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

List all artifacts for a job

Examples:

Buildkit.job_artifacts('my-great-org', 'great-pipeline', 42, '76365070-34d5-4104-8b91-952780f8029f')

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite artifacts.

See Also:

• https://buildkite.com/docs/rest-api/artifacts#list-artifacts-for-a-job

# File 'lib/buildkit/client/artifacts.rb', line 25

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