8000 chore: add docs for schedule pipelines · python-gitlab/python-gitlab@9a9a6a9 · GitHub
[go: up one dir, main page]

Skip to content

Commit 9a9a6a9

Browse files
committed
chore: add docs for schedule pipelines
1 parent 865fa41 commit 9a9a6a9

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/gl_objects/pipelines_and_jobs.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ objects to get the associated project::
112112

113113
Reference: https://docs.gitlab.com/ee/ci/triggers/#trigger-token
114114

115-
Pipeline schedule
116-
=================
115+
Pipeline schedules
116+
==================
117117

118118
You can schedule pipeline runs using a cron-like syntax. Variables can be
119119
associated with the scheduled pipelines.
@@ -128,7 +128,10 @@ Reference
128128
+ :attr:`gitlab.v4.objects.Project.pipelineschedules`
129129
+ :class:`gitlab.v4.objects.ProjectPipelineScheduleVariable`
130130
+ :class:`gitlab.v4.objects.ProjectPipelineScheduleVariableManager`
131-
+ :attr:`gitlab.v4.objects.Project.pipelineschedules`
131+
+ :attr:`gitlab.v4.objects.ProjectPipelineSchedule.variables`
132+
+ :class:`gitlab.v4.objects.ProjectPipelineSchedulePipeline`
133+
+ :class:`gitlab.v4.objects.ProjectPipelineSchedulePipelineManager`
134+
+ :attr:`gitlab.v4.objects.ProjectPipelineSchedule.pipelines`
132135

133136
* GitLab API: https://docs.gitlab.com/ce/api/pipeline_schedules.html
134137

@@ -188,6 +191,9 @@ Delete a schedule variable::
188191

189192
var.delete()
190193

194+
List all pipelines triggered by a pipeline schedule::
195+
196+
pipelines = sched.pipelines.list()
191197

192198
Jobs
193199
====

0 commit comments

Comments
 (0)
0