Class: CircleCi::Build

Inherits:
Object
  • Object
show all
Defined in:
lib/circleci/build.rb

Overview

Class for interacting with and managing builds

Class Method Summary collapse

Class Method Details

.artifacts(username, project, build) ⇒ CircleCi::Response

Get artifacts for a specific build of a project

Parameters:

  • username (String) —

    • User or org name who owns project

  • project (String) —

    • Name of project

  • build (String) —

    • Build ID

Returns:



15
16
17
 
# File 'lib/circleci/build.rb', line 15

def self.artifacts(username, project, build)
  CircleCi.http.get "/project/#{username}/#{project}/#{build}/artifacts"
end

.cancel(username, project, build) ⇒ CircleCi::Response

Cancel a specific build

Parameters:

  • username (String) —

    • User or org name who owns project

  • project (String) —

    • Name of project

  • build (String) —

    • Build ID

Returns:



28
29
30
 
# File 'lib/circleci/build.rb', line 28

def self.cancel(username, project, build)
  CircleCi.http.post "/project/#{username}/#{project}/#{build}/cancel"
end

.get(username, project, build) ⇒ CircleCi::Response

Get a specific build for a project

Parameters:

  • username (String) —

    • User or org name who owns project

  • project (String) —

    • Name of project

  • build (String) —

    • Build ID

Returns:



41
42
43
 
# File 'lib/circleci/build.rb', line 41

def self.get(username, project, build)
  CircleCi.http.get "/project/#{username}/#{project}/#{build}"
end

.retry(username, project, build) ⇒ CircleCi::Response

Kick off a retry of a specific build

Parameters:

  • username (String) —

    • User or org name who owns project

  • project (String) —

    • Name of project

  • build (String) —

    • Build ID

Returns:



54
55
56
 
# File 'lib/circleci/build.rb', line 54

def self.retry(username, project, build)
  CircleCi.http.post "/project/#{username}/#{project}/#{build}/retry"
end

.tests(username, project, build) ⇒ CircleCi::Response

Get tests for a specific build of a project

Parameters:

  • username (String) —

    • User or org name who owns project

  • project (String) —

    • Name of project

  • build (String) —

    • Build ID

Returns:



67
68
69
 
# File 'lib/circleci/build.rb', line 67

def self.tests(username, project, build)
  CircleCi.http.get "/project/#{username}/#{project}/#{build}/tests"
end