module Buildkit::Client::Builds

Methods for the Builds API

@see buildkite.com/docs/api/builds

Public Instance Methods

build(org, pipeline, number, options = {}) click to toggle source

Get a build

@param org [String] Organization slug. @param pipeline [String] pipeline slug. @param number [Integer] Build number. @return [Sawyer::Resource] Hash representing Buildkite build. @see buildkite.com/docs/api/builds#get-a-build @example

Buildkit.build('my-great-org', 'great-pipeline', 42)
# 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 = {}) click to toggle source

List all builds

@return [Array<Sawyer::Resource>] Array of hashes representing Buildkite builds. @see buildkite.com/docs/api/builds#list-all-builds @example

Buildkit.builds
# File lib/buildkit/client/builds.rb, line 15
def builds(options = {})
  get('/v2/builds', options)
end
cancel_build(org, pipeline, number, options = {}) click to toggle source

Cancel a build

@param org [String] Organization slug. @param pipeline [String] pipeline slug. @param number [Integer] Build number. @see buildkite.com/docs/rest-api/builds#cancel-a-build @example

Buildkit.cancel_build('my-great-org', 'great-pipeline', 42)
# 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 = {}) click to toggle source

Create a build

@param org [String] Organization slug. @param pipeline [String] pipeline slug. @see buildkite.com/docs/api/builds#create-a-build @example

Buildkit.create_build('my-great-org', 'great-pipeline', {
  commit: 'HEAD',
  branch: 'master',
  message: 'Hello, world!',
  author: {
    name: 'Liam Neeson',
    email: 'liam@evilbatmanvillans.com'
  }
})
# 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 = {}) click to toggle source

List builds for an organization

@param org [String] Organization slug. @return [Array<Sawyer::Resource>] Array of hashes representing Buildkite builds. @see buildkite.com/docs/api/builds#list-builds-for-an-organization @example

Buildkit.organization_builds('my-great-org'))
# 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 = {}) click to toggle source

List builds for a pipeline

@param org [String] Organization slug. @param pipeline [String] pipeline slug. @return [Array<Sawyer::Resource>] Array of hashes representing Buildkite builds. @see buildkite.com/docs/api/builds#list-builds-for-a-pipeline @example

Buildkit.pipeline_builds('my-great-org', 'great-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 = {}) click to toggle source

Rebuild a build

@param org [String] Organization slug. @param pipeline [String] pipeline slug. @param number [Integer] Build number. @see buildkite.com/docs/api/builds#rebuild-a-build @example

Buildkit.rebuild('my-great-org', 'great-pipeline', 42)
# 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