diff options
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/deployments.py | 11 | ||||
| -rw-r--r-- | docs/gl_objects/deployments.rst | 23 |
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/gl_objects/deployments.py b/docs/gl_objects/deployments.py new file mode 100644 index 0000000..fe1613a --- /dev/null +++ b/docs/gl_objects/deployments.py @@ -0,0 +1,11 @@ +# list +deployments = gl.project_deployments.list(project_id=1) +# or +deployments = project.deployments.list() +# end list + +# get +deployment = gl.project_deployments.get(deployment_id, project_id=1) +# or +deployment = project.deployments.get(deployment_id) +# end get diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst new file mode 100644 index 0000000..1a679da --- /dev/null +++ b/docs/gl_objects/deployments.rst @@ -0,0 +1,23 @@ +########### +Deployments +########### + +Use :class:`~gitlab.objects.ProjectDeployment` objects to manipulate project +deployments. The :attr:`gitlab.Gitlab.project_deployments`, and +:attr:`Project.deployments <gitlab.objects.Project.deployments>` manager +objects provide helper functions. + +Examples +-------- + +List deployments for a project: + +.. literalinclude:: deployments.py + :start-after: # list + :end-before: # end list + +Get a single deployment: + +.. literalinclude:: deployments.py + :start-after: # get + :end-before: # end get |