Module: Buildkit::Client::Builds

Included in:

Buildkit::Client

Defined in:

lib/buildkit/client/builds.rb

Overview

Methods for the Builds API

See Also:

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

Instance Method Summary

• #build(org, pipeline, number, options = {}) ⇒ Sawyer::Resource

  Get a build.

• #builds(options = {}) ⇒ Array<Sawyer::Resource>

  List all builds.

• #cancel_build(org, pipeline, number, options = {}) ⇒ Object

  Cancel a build.

• #create_build(org, pipeline, options = {}) ⇒ Object

  Create a build.

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

  List builds for an organization.

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

  List builds for a pipeline.

• #rebuild(org, pipeline, number, options = {}) ⇒ Object

  Rebuild a build.

Instance Method Details

#build(org, pipeline, number, options = {}) ⇒ Sawyer::Resource

Get a build

Examples:

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

See Also:

• https://buildkite.com/docs/api/builds#get-a-build

# File 'lib/buildkit/client/builds.rb', line 51

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

#builds(options = {}) ⇒ Array<Sawyer::Resource>

List all builds

Examples:

Buildkit.builds

See Also:

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

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

def builds(options = {})
  get('/v2/builds', options)
end

#cancel_build(org, pipeline, number, options = {}) ⇒ Object

Cancel a build

Examples:

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

See Also:

• https://buildkite.com/docs/rest-api/builds#cancel-a-build

# File 'lib/buildkit/client/builds.rb', line 95

def cancel_build(org, pipeline, number, options = {})
  put("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/cancel", options)
end

#create_build(org, pipeline, options = {}) ⇒ Object

Create a build

Examples:

Buildkit.create_build('my-great-org', 'great-pipeline', {
  commit: 'HEAD',
  branch: 'master',
  message: 'Hello, world!',
  author: {
    name: 'Liam Neeson',
    email: 'liam@evilbatmanvillans.com'
  }
})

See Also:

• https://buildkite.com/docs/api/builds#create-a-build

# File 'lib/buildkit/client/builds.rb', line 83

def create_build(org, pipeline, options = {})
  post("/v2/organizations/#{org}/pipelines/#{pipeline}/builds", options)
end

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

List builds for an organization

Examples:

Buildkit.organization_builds('my-great-org'))

See Also:

• https://buildkite.com/docs/api/builds#list-builds-for-an-organization

# File 'lib/buildkit/client/builds.rb', line 26

def organization_builds(org, options = {})
  get("/v2/organizations/#{org}/builds", options)
end

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

List builds for a pipeline

Examples:

Buildkit.pipeline_builds('my-great-org', 'great-pipeline')

See Also:

• https://buildkite.com/docs/api/builds#list-builds-for-a-pipeline

# File 'lib/buildkit/client/builds.rb', line 38

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

#rebuild(org, pipeline, number, options = {}) ⇒ Object

Rebuild a build

Examples:

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

See Also:

• https://buildkite.com/docs/api/builds#rebuild-a-build

# File 'lib/buildkit/client/builds.rb', line 63

def rebuild(org, pipeline, number, options = {})
  put("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/rebuild", options)
end