summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api-objects.rst1
-rw-r--r--docs/gl_objects/runners.py22
-rw-r--r--docs/gl_objects/runners.rst45
3 files changed, 68 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index 19e8a22..2f9263a 100644
--- a/docs/api-objects.rst
+++ b/docs/api-objects.rst
@@ -6,4 +6,5 @@ API objects manipulation
gl_objects/branches
gl_objects/projects
+ gl_objects/runners
gl_objects/users
diff --git a/docs/gl_objects/runners.py b/docs/gl_objects/runners.py
new file mode 100644
index 0000000..5092dc0
--- /dev/null
+++ b/docs/gl_objects/runners.py
@@ -0,0 +1,22 @@
+# list
+# List owned runners
+runners = gl.runners.list()
+# List all runners, using a filter
+runners = gl.runners.all(scope='paused')
+# end list
+
+# get
+runner = gl.runners.get(runner_id)
+# end get
+
+# update
+runner = gl.runners.get(runner_id)
+runner.tag_list.append('new_tag')
+runner.save()
+# end update
+
+# delete
+gl.runners.delete(runner_id)
+# or
+runner.delete()
+# end delete
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst
new file mode 100644
index 0000000..08c4bc7
--- /dev/null
+++ b/docs/gl_objects/runners.rst
@@ -0,0 +1,45 @@
+#######
+Runners
+#######
+
+Global runners
+==============
+
+Use :class:`~gitlab.objects.Runner` objects to manipulate runners. The
+:attr:`gitlab.Gitlab.runners` manager object provides helper functions.
+
+Examples
+--------
+
+Use the ``list()`` and ``all()`` methods to list runners.
+
+ The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
+values for this parameter are ``specific``, ``shared``, ``active``, ``paused``
+and ``online``.
+
+.. note::
+
+ 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:
+
+.. literalinclude:: runners.py
+ :start-after: # get
+ :end-before: # end get
+
+Update a runner:
+
+.. literalinclude:: runners.py
+ :start-after: # update
+ :end-before: # end update
+
+Remove a runner:
+
+.. literalinclude:: runners.py
+ :start-after: # delete
+ :end-before: # end delete