diff options
| -rw-r--r-- | docs/api-objects.rst | 1 | ||||
| -rw-r--r-- | docs/gl_objects/builds.py | 99 | ||||
| -rw-r--r-- | docs/gl_objects/builds.rst | 147 |
3 files changed, 247 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 2f9263a..1212fb6 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -5,6 +5,7 @@ API objects manipulation .. toctree:: gl_objects/branches + gl_objects/builds gl_objects/projects gl_objects/runners gl_objects/users diff --git a/docs/gl_objects/builds.py b/docs/gl_objects/builds.py new file mode 100644 index 0000000..4b663c6 --- /dev/null +++ b/docs/gl_objects/builds.py @@ -0,0 +1,99 @@ +# var list +variables = gl.project_variables.list(project_id=1) +# or +variables = project.variables.list() +# end var list + +# var get +var = gl.project_variables.get(var_key, project_id=1) +# or +var = project.variables.get(var_key) +# end var get + +# var create +var = gl.project_variables.create({'key': 'key1', 'value': 'value1'}, + project_id=1) +# or +var = project.variables.create({'key': 'key1', 'value': 'value1'}) +# end var create + +# var update +var.value = 'new_value' +var.save() +# end var update + +# var delete +gl.project_variables.delete(var_key) +# or +project.variables.delete() +# or +var.delete() +# end var delete + +# trigger list +triggers = gl.project_triggers.list(project_id=1) +# or +triggers = project.triggers.list() +# end trigger list + +# trigger get +trigger = gl.project_triggers.get(trigger_token, project_id=1) +# or +trigger = project.triggers.get(trigger_token) +# end trigger get + +# trigger create +trigger = gl.project_triggers.create({}, project_id=1) +# or +trigger = project.triggers.create({}) +# end trigger create + +# trigger delete +gl.project_triggers.delete(trigger_token) +# or +project.triggers.delete() +# or +trigger.delete() +# end trigger delete + +# list +builds = gl.project_builds.list(project_id=1) +# or +builds = project.builds.list() +# end list + +# commit list +commit = gl.project_commits.get(commit_sha, project_id=1) +builds = commit.builds() +# end commit list + +# get +build = gl.project_builds.get(build_id, project_id=1) +# or +project.builds.get(build_id) +# end get + +# artifacts +build.artifacts() +# end artifacts + +# keep artifacts +build.keep_artifacts() +# end keep artifacts + +# trace +build.trace() +# end trace + +# retry +build.cancel() +build.retry() +# end retry + +# delete +gl.project_builds.delete(build_id, project_id=1) +# or +project.builds.delete(build_id) +# or +build.delete() +# end delete diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst new file mode 100644 index 0000000..23f47f0 --- /dev/null +++ b/docs/gl_objects/builds.rst @@ -0,0 +1,147 @@ +###### +Builds +###### + +Build triggers +============== + +Use :class:`~gitlab.objects.ProjectTrigger` objects to manipulate build +triggers. The :attr:`gitlab.Gitlab.project_triggers` and +:attr:`gitlab.objects.Projeect.triggers` manager objects provide helper +functions. + +Examples +-------- + +List triggers: + +.. literalinclude:: builds.py + :start-after: # trigger list + :end-before: # end trigger list + +Get a trigger: + +.. literalinclude:: builds.py + :start-after: # trigger get + :end-before: # end trigger get + +Create a trigger: + +.. literalinclude:: builds.py + :start-after: # trigger create + :end-before: # end trigger create + +Remove a trigger: + +.. literalinclude:: builds.py + :start-after: # trigger delete + :end-before: # end trigger delete + +Build variables +=============== + +Use :class:`~gitlab.objects.ProjectVariable` objects to manipulate build +variables. The :attr:`gitlab.Gitlab.project_variables` and +:attr:`gitlab.objects.Projeect.variables` manager objects provide helper +functions. + +Examples +-------- + +List variables: + +.. literalinclude:: builds.py + :start-after: # var list + :end-before: # end var list + +Get a variable: + +.. literalinclude:: builds.py + :start-after: # var get + :end-before: # end var get + +Create a variable: + +.. literalinclude:: builds.py + :start-after: # var create + :end-before: # end var create + +Update a variable value: + +.. literalinclude:: builds.py + :start-after: # var update + :end-before: # end var update + +Remove a variable: + +.. literalinclude:: builds.py + :start-after: # var delete + :end-before: # end var delete + +Builds +====== + +Use :class:`~gitlab.objects.ProjectBuild` objects to manipulate builds. The +:attr:`gitlab.Gitlab.project_builds` and :attr:`gitlab.objects.Projeect.builds` +manager objects provide helper functions. + +Examples +-------- + +List builds for the project: + +.. literalinclude:: builds.py + :start-after: # list + :end-before: # end list + +To list builds for a specific commit, create a +:class:`~gitlab.objects.ProjectCommit` object and use its +:attr:`~gitlab.objects.ProjectCommit.builds` method: + +.. literalinclude:: builds.py + :start-after: # commit list + :end-before: # end commit list + +Get a build: + +.. literalinclude:: builds.py + :start-after: # get + :end-before: # end get + +Get a build artifacts: + +.. literalinclude:: builds.py + :start-after: # artifacts + :end-before: # end artifacts + +.. warning:: + + Artifacts are entirely stored in memory. + +Mark a build artifact as kept when expiration is set: + +.. literalinclude:: builds.py + :start-after: # keep artifacts + :end-before: # end keep artifacts + +Get a build trace: + +.. literalinclude:: builds.py + :start-after: # trace + :end-before: # end trace + +.. warning:: + + Traces are entirely stored in memory. + +Cancel/retry a build: + +.. literalinclude:: builds.py + :start-after: # retry + :end-before: # end retry + +Erase a build: + +.. literalinclude:: builds.py + :start-after: # delete + :end-before: # end delete |