summaryrefslogtreecommitdiff
path: root/docs/gl_objects/projects.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-08-27 22:21:49 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-08-27 22:21:49 +0200
commit8257400fd78e0fdc26fdcb207dbc6e923332e209 (patch)
tree5984672107fc68f0f9b6f7889b3b26f2393efe23 /docs/gl_objects/projects.rst
parentef2dbf7034aee21ecf225be5cfefee8ab4379bbe (diff)
downloadgitlab-8257400fd78e0fdc26fdcb207dbc6e923332e209.tar.gz
Add support for project pipelines
Diffstat (limited to 'docs/gl_objects/projects.rst')
-rw-r--r--docs/gl_objects/projects.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index 5d8e61f..387ba34 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -395,6 +395,37 @@ Delete a project hook:
:start-after: # hook delete
:end-before: # end hook delete
+Pipelines
+---------
+
+Use :class:`~gitlab.objects.ProjectPipeline` objects to manipulate projects
+pipelines. The :attr:`gitlab.Gitlab.project_pipelines` and
+:attr:`Project.services <gitlab.objects.Projects.pipelines>` manager objects
+provide helper functions.
+
+List pipelines for a project:
+
+.. literalinclude:: projects.py
+ :start-after: # pipeline list
+ :end-before: # end pipeline list
+
+Get a pipeline for a project:
+
+.. literalinclude:: projects.py
+ :start-after: # pipeline get
+ :end-before: # end pipeline get
+
+Retry the failed builds for a pipeline:
+
+.. literalinclude:: projects.py
+ :start-after: # pipeline retry
+ :end-before: # end pipeline retry
+
+Cancel builds in a pipeline:
+
+.. literalinclude:: projects.py
+ :start-after: # pipeline cancel
+ :end-before: # end pipeline cancel
Services
--------