summaryrefslogtreecommitdiff
path: root/docs/gl_objects/releases.rst
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-12-01 01:04:53 +0100
committerGitHub <noreply@github.com>2021-12-01 01:04:53 +0100
commit8d76826fa64460e504acc5924f859f8dbc246b42 (patch)
tree083fefada982c795e2415092794db429abb0c184 /docs/gl_objects/releases.rst
parent5a1678f43184bd459132102cc13cf8426fe0449d (diff)
parent86ab04e54ea4175f10053decfad5086cda7aa024 (diff)
downloadgitlab-master.tar.gz
Merge pull request #1723 from python-gitlab/jlvillal/dead_mastermaster
Close-out `master` branch
Diffstat (limited to 'docs/gl_objects/releases.rst')
-rw-r--r--docs/gl_objects/releases.rst83
1 files changed, 0 insertions, 83 deletions
diff --git a/docs/gl_objects/releases.rst b/docs/gl_objects/releases.rst
deleted file mode 100644
index 6077fe9..0000000
--- a/docs/gl_objects/releases.rst
+++ /dev/null
@@ -1,83 +0,0 @@
-########
-Releases
-########
-
-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')
-
-Edit a release::
-
- release.name = "Demo Release"
- release.description = "release notes go here"
- release.save()
-
-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::
-
- # via its tag name from project attributes
- release = project.releases.delete('v1.2.3')
-
- # delete object directly
- release.delete()
-
-Project release links
-=====================
-
-Reference
----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectReleaseLink`
- + :class:`gitlab.v4.objects.ProjectReleaseLinkManager`
- + :attr:`gitlab.v4.objects.ProjectRelease.links`
-
-* Gitlab API: https://docs.gitlab.com/ee/api/releases/links.html
-
-Examples
---------
-
-Get a list of releases from a project::
-
- links = release.links.list()
-
-Get a single release link::
-
- link = release.links.get(1)
-
-Create a release link for a release::
-
- link = release.links.create({"url": "https://example.com/asset", "name": "asset"})
-
-Delete a release link::
-
- # via its ID from release attributes
- release.links.delete(1)
-
- # delete object directly
- link.delete()