diff options
| author | Matthieu Rigal <matthieu.rigal@jonasundderwolf.de> | 2022-01-21 15:56:03 +0100 |
|---|---|---|
| committer | Matthieu Rigal <matthieu.rigal@jonasundderwolf.de> | 2022-01-21 19:00:50 +0100 |
| commit | 5d973de8a5edd08f38031cf9be2636b0e12f008d (patch) | |
| tree | e7e24055384dfeaf895b9adce5fbf711f4a04aad | |
| parent | ff4b1cc70910b5c45df96547815390736a550b54 (diff) | |
| download | gitlab-5d973de8a5edd08f38031cf9be2636b0e12f008d.tar.gz | |
docs: enhance release docs for CI_JOB_TOKEN usage
| -rw-r--r-- | docs/gl_objects/releases.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/gl_objects/releases.rst b/docs/gl_objects/releases.rst index 6077fe9..cb21db2 100644 --- 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 ===================== |