diff options
| -rw-r--r-- | docs/gl_objects/builds.rst | 4 | ||||
| -rw-r--r-- | gitlab/v4/objects.py | 32 |
2 files changed, 36 insertions, 0 deletions
diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst index f20fe17..a62d798 100644 --- a/docs/gl_objects/builds.rst +++ b/docs/gl_objects/builds.rst @@ -319,6 +319,10 @@ Get a single artifact file:: build_or_job.artifact('path/to/file') +Get a single artifact file by branch and job:: + + project.artifact('branch', 'path/to/file', 'job') + Mark a job artifact as kept when expiration is set:: build_or_job.keep_artifacts() diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py index f452aa7..c598a9a 100644 --- a/gitlab/v4/objects.py +++ b/gitlab/v4/objects.py @@ -4263,6 +4263,38 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject): ) + @cli.register_custom_action("Project", ("ref_name", "artifact_path", "job")) + @exc.on_http_error(exc.GitlabGetError) + def artifact(self, ref_name, artifact_path, job, streamed=False, action=None, chunk_size=1024, **kwargs): + """Download a single artifact file from a specific tag or branch from within the job’s artifacts archive. + + Args: + ref_name (str): Branch or tag name in repository. HEAD or SHA references are not supported. + artifact_path (str): Path to a file inside the artifacts archive. + job (str): The name of the job. + streamed (bool): If True the data will be processed by chunks of + `chunk_size` and each chunk is passed to `action` for + treatment + action (callable): Callable responsible of dealing with chunk of + data + chunk_size (int): Size of each chunk + **kwargs: Extra options to send to the server (e.g. sudo) + + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabGetError: If the artifacts could not be retrieved + + Returns: + str: The artifacts if `streamed` is False, None otherwise. + """ + + path = "/projects/%s/jobs/artifacts/%s/raw/%s?job=%s" % (self.get_id(), ref_name, artifact_path, job) + result = self.manager.gitlab.http_get( + path, streamed=streamed, raw=True, **kwargs + ) + return utils.response_content(result, streamed, action, chunk_size) + + class ProjectManager(CRUDMixin, RESTManager): _path = "/projects" _obj_cls = Project |