Merge pull request python-gitlab#159 from JonathonReinhart/158-erase-build

Gauvain Pocentek · web-flow · commit d4a24a5c4dc5 · 2016-10-03T06:31:48.000+02:00
Add ProjectBuild.erase()
diff --git a/docs/gl_objects/builds.py b/docs/gl_objects/builds.py
@@ -103,10 +103,6 @@ def __call__(self, chunk):
 build.retry()
 # end retry
 
-# delete
-gl.project_builds.delete(build_id, project_id=1)
-# or
-project.builds.delete(build_id)
-# or
-build.delete()
-# end delete
+# erase
+build.erase()
+# end erase
diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst
@@ -150,8 +150,8 @@ Cancel/retry a build:
    :start-after: # retry
    :end-before: # end retry
 
-Erase a build:
+Erase a build (artifacts and trace):
 
 .. literalinclude:: builds.py
-   :start-after: # delete
-   :end-before: # end delete
+   :start-after: # erase
+   :end-before: # end erase
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -95,6 +95,10 @@ class GitlabBuildRetryError(GitlabRetryError):
     pass
 
 
+class GitlabBuildEraseError(GitlabRetryError):
+    pass
+
+
 class GitlabPipelineRetryError(GitlabRetryError):
     pass
 
diff --git a/gitlab/objects.py b/gitlab/objects.py
@@ -961,6 +961,12 @@ def retry(self, **kwargs):
         r = self.gitlab._raw_post(url)
         raise_error_from_response(r, GitlabBuildRetryError, 201)
 
+    def erase(self, **kwargs):
+        """Erase the build (remove build artifacts and trace)."""
+        url = '/projects/%s/builds/%s/erase' % (self.project_id, self.id)
+        r = self.gitlab._raw_post(url)
+        raise_error_from_response(r, GitlabBuildEraseError, 201)
+
     def keep_artifacts(self, **kwargs):
         """Prevent artifacts from being delete when expiration is set.
 
