Module: Gitlab::Client::BuildTriggers

Included in:

Gitlab::Client

Defined in:

lib/gitlab/client/build_triggers.rb

Overview

Defines methods related to builds.

See Also:

• https://docs.gitlab.com/ce/api/build_triggers.html

Instance Method Summary

• #create_trigger(project) ⇒ Gitlab::ObjectifiedHash

  Create a build trigger for a project.

• #remove_trigger(project, token) ⇒ Gitlab::ObjectifiedHash

  Remove a project’s build trigger.

• #trigger(project, token) ⇒ Gitlab::ObjectifiedHash

  Gets details of project’s build trigger.

• #triggers(project) ⇒ Array<Gitlab::ObjectifiedHash>

  Gets a list of the project’s build triggers.

Instance Method Details

#create_trigger(project) ⇒ Gitlab::ObjectifiedHash

Create a build trigger for a project.

Examples:

Gitlab.create_trigger(5)

Parameters:

• project (Integer) —

  The ID of a project.

Returns:

• (Gitlab::ObjectifiedHash) —

  The trigger.

# File 'lib/gitlab/client/build_triggers.rb', line 35

def create_trigger(project)
  post("/projects/#{project}/triggers")
end

#remove_trigger(project, token) ⇒ Gitlab::ObjectifiedHash

Remove a project’s build trigger.

Examples:

Gitlab.remove_trigger(5, '7b9148c158980bbd9bcea92c17522d')

Parameters:

• project (Integer) —

  The ID of a project.

• token (String) —

  The token of a trigger.

Returns:

• (Gitlab::ObjectifiedHash) —

  The trigger.

# File 'lib/gitlab/client/build_triggers.rb', line 47

def remove_trigger(project, token)
  delete("/projects/#{project}/triggers/#{token}")
end

#trigger(project, token) ⇒ Gitlab::ObjectifiedHash

Gets details of project’s build trigger.

Examples:

Gitlab.trigger(5, '7b9148c158980bbd9bcea92c17522d')

Parameters:

• project (Integer) —

  The ID of a project.

• token (String) —

  The token of a trigger.

Returns:

• (Gitlab::ObjectifiedHash) —

  The trigger.

# File 'lib/gitlab/client/build_triggers.rb', line 24

def trigger(project, token)
  get("/projects/#{project}/triggers/#{token}")
end

#triggers(project) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of the project’s build triggers

Examples:

Gitlab.triggers(5)

Parameters:

• project (Integer) —

  The ID of a project.

Returns:

• (Array<Gitlab::ObjectifiedHash>) —

  The list of triggers.

# File 'lib/gitlab/client/build_triggers.rb', line 12

def triggers(project)
  get("/projects/#{project}/triggers")
end