Module: Buildkit::Client::Pipelines

Included in:

Buildkit::Client

Defined in:

lib/buildkit/client/pipelines.rb

Overview

Methods for the pipelines API

See Also:

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

Instance Method Summary

• #archive_pipeline(org, pipeline) ⇒ Sawyer::Resource

  Archive a pipeline.

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

  Create a pipeline.

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

  Get a pipeline.

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

  List pipelines.

• #unarchive_pipeline(org, pipeline) ⇒ Sawyer::Resource

  Unarchive a pipeline.

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

  Update a pipeline.

Instance Method Details

#archive_pipeline(org, pipeline) ⇒ Sawyer::Resource

Archive a pipeline

Examples:

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

Parameters:

• org (String) —

  Organization slug.

• pipeline (String) —

  pipeline slug.

Returns:

• (Sawyer::Resource) —

  Hash representing Buildkite pipeline

See Also:

• https://buildkite.com/docs/api/pipelines#archive-a-pipeline

# File 'lib/buildkit/client/pipelines.rb', line 78

def archive_pipeline(org, pipeline)
  post("/v2/organizations/#{org}/pipelines/#{pipeline}/archive")
end

#create_pipeline(org, options = {}) ⇒ Object

Create a pipeline

Examples:

Buildkit.create_pipeline('my-great-org', {
  name: 'My pipeline',
  repository: 'git@github.com:acme/pipeline.git',
  steps: [
    {
      type: 'script',
      name: 'Build',
      command: 'script/build.sh'
    }
  ],
  timeout_in_minutes: 10,
  agent_query_rules: ['test=true']
})

Parameters:

• org (String) —

  Organization slug.

See Also:

• https://buildkite.com/docs/api/pipelines#create-a-pipeline

# File 'lib/buildkit/client/pipelines.rb', line 50

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

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

Get a pipeline

Examples:

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

Parameters:

• org (String) —

  Organization slug.

• pipeline (String) —

  pipeline slug.

Returns:

• (Sawyer::Resource) —

  Hash representing Buildkite pipeline

See Also:

• https://buildkite.com/docs/api/pipelines#get-a-pipeline

# File 'lib/buildkit/client/pipelines.rb', line 27

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

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

List pipelines

Examples:

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

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite pipelines.

See Also:

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

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

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

#unarchive_pipeline(org, pipeline) ⇒ Sawyer::Resource

Unarchive a pipeline

Examples:

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

Parameters:

• org (String) —

  Organization slug.

• pipeline (String) —

  pipeline slug.

Returns:

• (Sawyer::Resource) —

  Hash representing Buildkite pipeline

See Also:

• https://buildkite.com/docs/api/pipelines#unarchive-a-pipeline

# File 'lib/buildkit/client/pipelines.rb', line 91

def unarchive_pipeline(org, pipeline)
  post("/v2/organizations/#{org}/pipelines/#{pipeline}/unarchive")
end

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

Update a pipeline

Examples:

Buildkit.update_pipeline('my-great-org', 'great-pipeline', {
  name: 'My pipeline 2',
})

Parameters:

• org (String) —

  Organization slug.

• pipeline (String) —

  pipeline slug.

Returns:

• (Sawyer::Resource) —

  Hash representing Buildkite pipeline

See Also:

• https://buildkite.com/docs/api/pipelines#update-a-pipeline

# File 'lib/buildkit/client/pipelines.rb', line 65

def update_pipeline(org, pipeline, options = {})
  patch("/v2/organizations/#{org}/pipelines/#{pipeline}", options)
end