Skip to content

Add custom project pipeline schedule play command #1068

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

Closed
wants to merge 8 commits into from
Closed

Add custom project pipeline schedule play command #1068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a64e164
Add a play option to a pipeline schedule to trigger it immediately
twonds Apr 8, 2020
fc3c2b3
return the response from the api
twonds Apr 8, 2020
4efc74c
return the response from the api as json with pipeline id
twonds Apr 8, 2020
68232f8
return the response from the api
twonds Apr 8, 2020
e85a718
feat: Add a play option to a pipeline schedule to trigger it immediately
twonds Apr 8, 2020
e94fe00
Merge branch 'feature/add-custom-pipeline-schedule-play' of github.co…
twonds Apr 8, 2020
cc8d91e
feat: Add a play option to a pipeline schedule to trigger it immediately
twonds Apr 8, 2020
88e629a
Merge branch 'feature/add-custom-pipeline-schedule-play' of github.co…
twonds Apr 8, 2020
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
2 changes: 1 addition & 1 deletion gitlab/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
from gitlab import utils # noqa

__title__ = "python-gitlab"
__version__ = "2.2.0"
__version__ = "2.2.1"
__author__ = "Gauvain Pocentek"
__email__ = "gauvainpocentek@gmail.com"
__license__ = "LGPL3"
Expand Down
18 changes: 18 additions & 0 deletions gitlab/v4/objects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3774,6 +3774,24 @@ def take_ownership(self, **kwargs):
server_data = self.manager.gitlab.http_post(path, **kwargs)
self._update_attrs(server_data)

@cli.register_custom_action("ProjectPipelineSchedule")
@exc.on_http_error(exc.GitlabOwnershipError)
def play(self, **kwargs):
# https://docs.gitlab.com/ee/api/pipeline_schedules.html#run-a-scheduled-pipeline-immediately # noqa
"""Play a pipeline schedule immediately.

Args:
**kwargs: Extra options to send to the server (e.g. sudo)

Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabOwnershipError: If the request failed
"""
path = "%s/%s/play" % (self.manager.path, self.get_id())
server_data = self.manager.gitlab.http_post(path, **kwargs)
self._update_attrs(server_data)
return server_data


class ProjectPipelineScheduleManager(CRUDMixin, RESTManager):
_path = "/projects/%(project_id)s/pipeline_schedules"
Expand Down