From 04435e1b13166fb45216c494f3af4d9bdb76bcaf Mon Sep 17 00:00:00 2001
From: Gauvain Pocentek <gauvain@pocentek.net>
Date: Sat, 21 Jan 2017 14:42:12 +0100
Subject: Add support for project runners

This API allows to enable/disable specific runners for a project, and to
list the project associated runners.

Fix #205
---
 docs/gl_objects/runners.py  | 18 ++++++++++++++++++
 docs/gl_objects/runners.rst | 42 ++++++++++++++++++++++++++++++++++++++----
 2 files changed, 56 insertions(+), 4 deletions(-)

(limited to 'docs/gl_objects')

diff --git a/docs/gl_objects/runners.py b/docs/gl_objects/runners.py
index 3de36df..1a9cb82 100644
--- a/docs/gl_objects/runners.py
+++ b/docs/gl_objects/runners.py
@@ -22,3 +22,21 @@ gl.runners.delete(runner_id)
 # or
 runner.delete()
 # end delete
+
+# project list
+runners = gl.project_runners.list(project_id=1)
+# or
+runners = project.runners.list()
+# end project list
+
+# project enable
+p_runner = gl.project_runners.create({'runner_id': runner.id}, project_id=1)
+# or
+p_runner = project.runners.create({'runner_id': runner.id})
+# end project enable
+
+# project disable
+gl.project_runners.delete(runner.id)
+# or
+project.runners.delete(runner.id)
+# end project disable
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst
index 2f7e599..02db9be 100644
--- a/docs/gl_objects/runners.rst
+++ b/docs/gl_objects/runners.rst
@@ -2,11 +2,17 @@
 Runners
 #######
 
-Global runners
-==============
+Runners are external process used to run CI jobs. They are deployed by the
+administrator and registered to the GitLab instance.
 
-Use :class:`~gitlab.objects.Runner` objects to manipulate runners. The
-:attr:`gitlab.Gitlab.runners` manager object provides helper functions.
+Shared runners are available for all projects. Specific runners are enabled for
+a list of projects.
+
+Global runners (admin)
+======================
+
+* Object class: :class:`~gitlab.objects.Runner`
+* Manager objects: :attr:`gitlab.Gitlab.runners`
 
 Examples
 --------
@@ -48,3 +54,31 @@ Remove a runner:
 .. literalinclude:: runners.py
    :start-after: # delete
    :end-before: # end delete
+
+Project runners
+===============
+
+* Object class: :class:`~gitlab.objects.ProjectRunner`
+* Manager objects: :attr:`gitlab.Gitlab.runners`,
+  :attr:`gitlab.Gitlab.Project.runners`
+
+Examples
+--------
+
+List the runners for a project:
+
+.. literalinclude:: runners.py
+   :start-after: # project list
+   :end-before: # end project list
+
+Enable a specific runner for a project:
+
+.. literalinclude:: runners.py
+   :start-after: # project enable
+   :end-before: # end project enable
+
+Disable a specific runner for a project:
+
+.. literalinclude:: runners.py
+   :start-after: # project disable
+   :end-before: # end project disable
-- 
cgit v1.2.1