summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKris Gambirazzi <Kris.Gambirazzi@perkbox.com>2019-03-27 12:13:18 +0000
committerKris Gambirazzi <Kris.Gambirazzi@perkbox.com>2019-03-27 12:13:18 +0000
commit3680545a01513ed044eb888151d2e2c635cea255 (patch)
tree26d4b0a02ba73199d3bfaf415ed5c4ad7813ecfd /docs
parenta3a771310de16be7bba041c962223f7bda9aa4d6 (diff)
downloadgitlab-3680545a01513ed044eb888151d2e2c635cea255.tar.gz
add project releases api
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/projects.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index b91f5f2..c151889 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -663,6 +663,39 @@ Delete project push rules::
pr.delete()
+Project releases
+================
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.ProjectRelease`
+ + :class:`gitlab.v4.objects.ProjectReleaseManager`
+ + :attr:`gitlab.v4.objects.Project.releases`
+
+* Gitlab API: https://docs.gitlab.com/ee/api/releases/index.html
+
+Examples
+--------
+
+Get a list of releases from a project::
+
+ release = project.releases.list()
+
+Get a single release::
+
+ release = project.releases.get('v1.2.3')
+
+Create a release for a project tag::
+
+ release = project.releases.create({'name':'Demo Release', 'tag_name':'v1.2.3', 'description':'release notes go here'})
+
+Delete a release::
+
+ release = p.releases.delete('v1.2.3')
+
Project protected tags
======================