8000 add project releases api by therealgambo · Pull Request #746 · python-gitlab/python-gitlab · GitHub
[go: up one dir, main page]

Skip to content

add project releases api #746

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.

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 2 commits into from
Apr 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions docs/gl_objects/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
======================

Expand Down
12 changes: 12 additions & 0 deletions gitlab/v4/objects.py
Original file line number Diff line number Diff line change
Expand Up @@ -1993,6 +1993,17 @@ class ProjectPagesDomainManager(CRUDMixin, RESTManager):
_update_attrs = (tuple(), ('certificate', 'key'))


class ProjectRelease(RESTObject):
_id_attr = 'tag_name'


class ProjectReleaseManager(NoUpdateMixin, RESTManager):
_path = '/projects/%(project_id)s/releases'
_obj_cls = ProjectRelease
_from_parent_attrs = {'project_id': 'id'}
_create_attrs = (('name', 'tag_name', 'description', ), ('ref', 'assets', ))


class ProjectTag(ObjectDeleteMixin, RE 66D7 STObject):
_id_attr = 'name'
_short_print_attr = 'name'
Expand Down Expand Up @@ -3273,6 +3284,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
('protectedtags', 'ProjectProtectedTagManager'),
('pipelineschedules', 'ProjectPipelineScheduleManager'),
('pushrules', 'ProjectPushRulesManager'),
('releases', 'ProjectReleaseManager'),
('runners', 'ProjectRunnerManager'),
('services', 'ProjectServiceManager'),
('snippets', 'ProjectSnippetManager'),
Expand Down
0