Module: Gitlab::Client::BuildVariables

Included in:
Gitlab::Client
Defined in:
lib/gitlab/client/build_variables.rb

Overview

Defines methods related to builds.

Instance Method Summary collapse

Instance Method Details

#create_group_variable(group, key, value, **opts) ⇒ Gitlab::ObjectifiedHash

Create a build variable for a group.

Examples:

Gitlab.create_group_variable(5, "NEW_VARIABLE", "new value")

Parameters:

  • group (Integer, String)

    The ID or name of a group.

  • key (String)

    The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed

  • value (String)

    The value of a variable

  • opts (Hash)

    optional parameters

Returns:


104
105
106
# File 'lib/gitlab/client/build_variables.rb', line 104

def create_group_variable(group, key, value, **opts)
  post("/groups/#{url_encode group}/variables", body: opts.merge(key: key, value: value))
end

#create_variable(project, key, value, **opts) ⇒ Gitlab::ObjectifiedHash

Create a build variable for a project.

Examples:

Gitlab.create_variable(5, "NEW_VARIABLE", "new value")

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • key (String)

    The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed

  • value (String)

    The value of a variable

  • opts (Hash)

    optional parameters

Returns:


41
42
43
# File 'lib/gitlab/client/build_variables.rb', line 41

def create_variable(project, key, value, **opts)
  post("/projects/#{url_encode project}/variables", body: opts.merge(key: key, value: value))
end

#group_variable(group, key) ⇒ Gitlab::ObjectifiedHash

Gets details of a group's specific build variable.

Examples:

Gitlab.group_variable(5, "TEST_VARIABLE_1")

Parameters:

  • group (Integer, String)

    The ID or name of a group.

  • key (String)

    The key of a variable.

Returns:


90
91
92
# File 'lib/gitlab/client/build_variables.rb', line 90

def group_variable(group, key)
  get("/groups/#{url_encode group}/variables/#{key}")
end

#group_variables(group) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of the group's build variables

Examples:

Gitlab.group_variables(5)

Parameters:

  • group (Integer, String)

    The ID or name of a group.

Returns:


78
79
80
# File 'lib/gitlab/client/build_variables.rb', line 78

def group_variables(group)
  get("/groups/#{url_encode group}/variables")
end

#remove_group_variable(group, key) ⇒ Gitlab::ObjectifiedHash

Remove a group's build variable.

Examples:

Gitlab.remove_group_variable(5, "VARIABLE_1")

Parameters:

  • group (Integer, String)

    The ID or name of a group.

  • key (String)

    The key of a variable.

Returns:


130
131
132
# File 'lib/gitlab/client/build_variables.rb', line 130

def remove_group_variable(group, key)
  delete("/groups/#{url_encode group}/variables/#{key}")
end

#remove_variable(project, key) ⇒ Gitlab::ObjectifiedHash

Remove a project's build variable.

Examples:

Gitlab.remove_variable(5, "VARIABLE_1")

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • key (String)

    The key of a variable.

Returns:


67
68
69
# File 'lib/gitlab/client/build_variables.rb', line 67

def remove_variable(project, key)
  delete("/projects/#{url_encode project}/variables/#{key}")
end

#update_group_variable(group, key, value, **opts) ⇒ Gitlab::ObjectifiedHash

Update a group's build variable.

Examples:

Gitlab.update_group_variable(5, "NEW_VARIABLE", "updated value")

Parameters:

  • group (Integer, String)

    The ID or name of a group.

  • key (String)

    The key of a variable

  • value (String)

    The value of a variable

  • opts (Hash)

    optional parameters

Returns:


118
119
120
# File 'lib/gitlab/client/build_variables.rb', line 118

def update_group_variable(group, key, value, **opts)
  put("/groups/#{url_encode group}/variables/#{key}", body: opts.merge(value: value))
end

#update_variable(project, key, value, **opts) ⇒ Gitlab::ObjectifiedHash

Update a project's build variable.

Examples:

Gitlab.update_variable(5, "NEW_VARIABLE", "updated value")

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • key (String)

    The key of a variable

  • value (String)

    The value of a variable

  • opts (Hash)

    optional parameters

Returns:


55
56
57
# File 'lib/gitlab/client/build_variables.rb', line 55

def update_variable(project, key, value, **opts)
  put("/projects/#{url_encode project}/variables/#{key}", body: opts.merge(value: value))
end

#variable(project, key) ⇒ Gitlab::ObjectifiedHash

Gets details of a project's specific build variable.

Examples:

Gitlab.variable(5, "TEST_VARIABLE_1")

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • key (String)

    The key of a variable.

Returns:


27
28
29
# File 'lib/gitlab/client/build_variables.rb', line 27

def variable(project, key)
  get("/projects/#{url_encode project}/variables/#{key}")
end

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

Gets a list of the project's build variables

Examples:

Gitlab.variables(5)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

Returns:


15
16
17
# File 'lib/gitlab/client/build_variables.rb', line 15

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