module Gitlab::CI::Client::Runners

Defines methods related to repositories. @see github.com/gitlabhq/gitlabhq/blob/master/doc/api/repositories.md

Public Instance Methods

delete_runner(token) click to toggle source

Used to remove runners.

@example

Gitlab::CI.delete_runner

@param [Hash] options A customizable set of options. @option options [String] token (required) - The runner token. @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/ci/client/runners.rb, line 40
def delete_runner(token)
  delete("/runners/delete", body: { token: token })
end
register_runner(token) click to toggle source

Used to make GitLab CI aware of available runners.

@example

Gitlab::CI.register_runner

@param [Hash] options A customizable set of options. @option options [String] token (required) - The registration token. It is 2 types of token you can pass here.

1. Shared runner registration token
2. Project specific registration token

@return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/ci/client/runners.rb, line 28
def register_runner(token)
  post("/runners/register", body: { token: token })
end
runners(options={}) click to toggle source

Used to get information about all runners registered on the GitLab CI instance.

@example

Gitlab::CI.runners

@param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/ci/client/runners.rb, line 14
def runners(options={})
  get("/runners", query: options)
end