summaryrefslogtreecommitdiff
path: root/docs/gl_objects/deployments.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects/deployments.rst')
-rw-r--r--docs/gl_objects/deployments.rst63
1 files changed, 0 insertions, 63 deletions
diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst
deleted file mode 100644
index 945ad41..0000000
--- a/docs/gl_objects/deployments.rst
+++ /dev/null
@@ -1,63 +0,0 @@
-###########
-Deployments
-###########
-
-Reference
----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectDeployment`
- + :class:`gitlab.v4.objects.ProjectDeploymentManager`
- + :attr:`gitlab.v4.objects.Project.deployments`
-
-* GitLab API: https://docs.gitlab.com/ce/api/deployments.html
-
-Examples
---------
-
-List deployments for a project::
-
- deployments = project.deployments.list()
-
-Get a single deployment::
-
- deployment = project.deployments.get(deployment_id)
-
-Create a new deployment::
-
- deployment = project.deployments.create({
- "environment": "Test",
- "sha": "1agf4gs",
- "ref": "master",
- "tag": False,
- "status": "created",
- })
-
-Update a deployment::
-
- deployment = project.deployments.get(42)
- deployment.status = "failed"
- deployment.save()
-
-Merge requests associated with a deployment
-===========================================
-
-Reference
-----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequest`
- + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequestManager`
- + :attr:`gitlab.v4.objects.ProjectDeployment.mergerequests`
-
-* GitLab API: https://docs.gitlab.com/ee/api/deployments.html#list-of-merge-requests-associated-with-a-deployment
-
-Examples
---------
-
-List the merge requests associated with a deployment::
-
- deployment = project.deployments.get(42, lazy=True)
- mrs = deployment.mergerequests.list()