diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-20 09:01:05 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-20 09:01:05 +0200 |
| commit | 5292ffb366f97e4dc611dfd49a1dca7d1e934f4c (patch) | |
| tree | 220659b39e0e5384504de3c63bbff003ad50eec2 /docs/gl_objects/runners.rst | |
| parent | 2c342372814bbac2203d7b4c0f2cd32541bab979 (diff) | |
| download | gitlab-5292ffb366f97e4dc611dfd49a1dca7d1e934f4c.tar.gz | |
[docs] Rework the examples pages
* Get rid of the .py files and bring all the python examples in the RST
files
* Fix a few things
Diffstat (limited to 'docs/gl_objects/runners.rst')
| -rw-r--r-- | docs/gl_objects/runners.rst | 64 |
1 files changed, 24 insertions, 40 deletions
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst index e26c8af..70bd60f 100644 --- a/docs/gl_objects/runners.rst +++ b/docs/gl_objects/runners.rst @@ -20,12 +20,6 @@ Reference + :class:`gitlab.v4.objects.RunnerManager` + :attr:`gitlab.Gitlab.runners` -* v3 API: - - + :class:`gitlab.v3.objects.Runner` - + :class:`gitlab.v3.objects.RunnerManager` - + :attr:`gitlab.Gitlab.runners` - * GitLab API: https://docs.gitlab.com/ce/api/runners.html Examples @@ -47,27 +41,30 @@ for this parameter are: The returned objects hold minimal information about the runners. Use the ``get()`` method to retrieve detail about a runner. -.. literalinclude:: runners.py - :start-after: # list - :end-before: # end list +:: -Get a runner's detail: + # List owned runners + runners = gl.runners.list() + # With a filter + runners = gl.runners.list(scope='active') + # List all runners, using a filter + runners = gl.runners.all(scope='paused') -.. literalinclude:: runners.py - :start-after: # get - :end-before: # end get +Get a runner's detail:: -Update a runner: + runner = gl.runners.get(runner_id) -.. literalinclude:: runners.py - :start-after: # update - :end-before: # end update +Update a runner:: -Remove a runner: + runner = gl.runners.get(runner_id) + runner.tag_list.append('new_tag') + runner.save() -.. literalinclude:: runners.py - :start-after: # delete - :end-before: # end delete +Remove a runner:: + + gl.runners.delete(runner_id) + # or + runner.delete() Project runners =============== @@ -81,32 +78,19 @@ Reference + :class:`gitlab.v4.objects.ProjectRunnerManager` + :attr:`gitlab.v4.objects.Project.runners` -* v3 API: - - + :class:`gitlab.v3.objects.ProjectRunner` - + :class:`gitlab.v3.objects.ProjectRunnerManager` - + :attr:`gitlab.v3.objects.Project.runners` - + :attr:`gitlab.Gitlab.project_runners` - * GitLab API: https://docs.gitlab.com/ce/api/runners.html Examples -------- -List the runners for a project: +List the runners for a project:: -.. literalinclude:: runners.py - :start-after: # project list - :end-before: # end project list + runners = project.runners.list() -Enable a specific runner for a project: +Enable a specific runner for a project:: -.. literalinclude:: runners.py - :start-after: # project enable - :end-before: # end project enable + p_runner = project.runners.create({'runner_id': runner.id}) -Disable a specific runner for a project: +Disable a specific runner for a project:: -.. literalinclude:: runners.py - :start-after: # project disable - :end-before: # end project disable + project.runners.delete(runner.id) |
