summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/deployments.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst
index ae10103..9c810ce 100644
--- a/docs/gl_objects/deployments.rst
+++ b/docs/gl_objects/deployments.rst
@@ -40,6 +40,18 @@ Update a deployment::
deployment.status = "failed"
deployment.save()
+Approve a deployment::
+
+ deployment = project.deployments.get(42)
+ # `status` must be either "approved" or "rejected".
+ deployment.approval(status="approved")
+
+Reject a deployment::
+
+ deployment = project.deployments.get(42)
+ # Using the optional `comment` and `represented_as` arguments
+ deployment.approval(status="rejected", comment="Fails CI", represented_as="security")
+
Merge requests associated with a deployment
===========================================