Merge pull request #1854 from MRigal/docs/small-releases-additions

nejch · web-flow · commit ff049005cc9e · 2022-01-21T23:03:33.000+01:00
Enhance releases API docs for CI_JOB_TOKEN usage
diff --git a/docs/gl_objects/releases.rst b/docs/gl_objects/releases.rst
@@ -21,6 +21,7 @@ Examples
 
 Get a list of releases from a project::
 
+    project = gl.projects.get(project_id, lazy=True)
     release = project.releases.list()
 
 Get a single release::
@@ -45,6 +46,14 @@ Delete a release::
     # delete object directly
     release.delete()
 
+.. note::
+
+    The Releases API is one of the few working with ``CI_JOB_TOKEN``, but the project can't
+    be fetched with the token. Thus use `lazy` for the project as in the above example.
+
+    Also be aware that most of the capabilities of the endpoint were not accessible with
+    ``CI_JOB_TOKEN`` until Gitlab version 14.5.
+
 Project release links
 =====================
 
