summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNejc Habjan <nejc.habjan@siemens.com>2022-02-02 02:06:52 +0100
committerJohn Villalovos <john@sodarock.com>2022-02-01 17:37:47 -0800
commit64d01ef23b1269b705350106d8ddc2962a780dce (patch)
treed988d7d1a2f0cdbd39cb0d9ca4239f8b6b93f88a
parent700d25d9bd812a64f5f1287bf50e8ddc237ec553 (diff)
downloadgitlab-64d01ef23b1269b705350106d8ddc2962a780dce.tar.gz
docs(artifacts): deprecate artifacts() and artifact() methods
-rw-r--r--docs/gl_objects/pipelines_and_jobs.rst16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/gl_objects/pipelines_and_jobs.rst b/docs/gl_objects/pipelines_and_jobs.rst
index b4761b0..ca802af 100644
--- a/docs/gl_objects/pipelines_and_jobs.rst
+++ b/docs/gl_objects/pipelines_and_jobs.rst
@@ -245,9 +245,14 @@ Get the artifacts of a job::
build_or_job.artifacts()
Get the artifacts of a job by its name from the latest successful pipeline of
-a branch or tag:
+a branch or tag::
- project.artifacts(ref_name='main', job='build')
+ project.artifacts.download(ref_name='main', job='build')
+
+.. attention::
+
+ An older method ``project.artifacts()`` is deprecated and will be
+ removed in a future version.
.. warning::
@@ -275,7 +280,12 @@ Get a single artifact file::
Get a single artifact file by branch and job::
- project.artifact('branch', 'path/to/file', 'job')
+ project.artifacts.raw('branch', 'path/to/file', 'job')
+
+.. attention::
+
+ An older method ``project.artifact()`` is deprecated and will be
+ removed in a future version.
Mark a job artifact as kept when expiration is set::