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, project, number, options = {}) ⇒ Sawyer::Resource

  Get a build.

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

  List all builds.

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

  List builds for an organization.

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

  List builds for a project.

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

  Rebuild a build.

Instance Method Details

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

Get a build

Examples:

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

Parameters:

• org (String) —

  Organization slug.

• project (String) —

  Project slug.

• number (Integer) —

  Build number.

Returns:

• (Sawyer::Resource) —

  Hash representing Buildkite build.

See Also:

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

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

def build(org, project, number, options = {})
  get("/v1/organizations/#{org}/projects/#{project}/builds/#{number}", options)
end

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

List all builds

Examples:

Buildkit.builds

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite builds.

See Also:

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

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

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

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

List builds for an organization

Examples:

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

Parameters:

• org (String) —

  Organization slug.

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite builds.

See Also:

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

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

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

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

List builds for a project

Examples:

Buildkit.project_builds('my-great-org', 'great-project')

Parameters:

• org (String) —

  Organization slug.

• project (String) —

  Project slug.

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite builds.

See Also:

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

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

def project_builds(org, project, options = {})
  get("/v1/organizations/#{org}/projects/#{project}/builds", options)
end

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

Rebuild a build

Examples:

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

Parameters:

• org (String) —

  Organization slug.

• project (String) —

  Project slug.

• number (Integer) —

  Build number.

See Also:

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

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

def rebuild(org, project, number, options = {})
  put("/v1/organizations/#{org}/projects/#{project}/builds/#{number}/rebuild", options)
end