Skip to content

Enhance releases API docs for CI_JOB_TOKEN usage #1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 21, 2022
Merged

Enhance releases API docs for CI_JOB_TOKEN usage #1854

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/gl_objects/releases.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand All @@ -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
=====================

Expand Down