feat: add play command to project pipeline schedules

twonds · twonds · commit 07b99881dfa6 · 2020-04-20T16:18:04.000-07:00
fix: remove version from setup

feat: add pipeline schedule play error exception

docs: add documentation for pipeline schedule play
diff --git a/docs/gl_objects/pipelines_and_jobs.rst b/docs/gl_objects/pipelines_and_jobs.rst
@@ -155,6 +155,11 @@ Update a schedule::
     sched.cron = '1 2 * * *'
     sched.save()
 
+Trigger a pipeline schedule immediately::
+
+    sched = projects.pipelineschedules.get(schedule_id)
+    sched.play()
+
 Delete a schedule::
 
     sched.delete()
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -145,6 +145,10 @@ class GitlabJobEraseError(GitlabRetryError):
     pass
 
 
+class GitlabPipelinePlayError(GitlabRetryError):
+    pass
+
+
 class GitlabPipelineRetryError(GitlabRetryError):
     pass
 
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -3775,6 +3775,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.GitlabPipelinePlayError)
+    def play(self, **kwargs):
+        """Trigger a new scheduled pipeline, which runs immediately.
+        The next scheduled run of this pipeline is not affected.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabPipelinePlayError: 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"
