blob: 1c95eb16ebaf36fd790a0fbe422c01e7dbebe28b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
###############################
Jobs (v4 API) / Builds (v3 API)
###############################
Build and job are two classes representing the same object. Builds are used in
v3 API, jobs in v4 API.
Triggers
========
Triggers provide a way to interact with the GitLab CI. Using a trigger a user
or an application can run a new build/job for a specific commit.
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectTrigger`
+ :class:`gitlab.v4.objects.ProjectTriggerManager`
+ :attr:`gitlab.v4.objects.Project.triggers`
* v3 API:
+ :class:`gitlab.v3.objects.ProjectTrigger`
+ :class:`gitlab.v3.objects.ProjectTriggerManager`
+ :attr:`gitlab.v3.objects.Project.triggers`
+ :attr:`gitlab.Gitlab.project_triggers`
* GitLab API: https://docs.gitlab.com/ce/api/pipeline_triggers.html
Examples
--------
List triggers:
.. literalinclude:: builds.py
:start-after: # trigger list
:end-before: # end trigger list
Get a trigger:
.. literalinclude:: builds.py
:start-after: # trigger get
:end-before: # end trigger get
Create a trigger:
.. literalinclude:: builds.py
:start-after: # trigger create
:end-before: # end trigger create
Remove a trigger:
.. literalinclude:: builds.py
:start-after: # trigger delete
:end-before: # end trigger delete
Projects and groups variables
=============================
You can associate variables to projects and groups to modify the build/job
scripts behavior.
Reference
---------
* v4 API
+ :class:`gitlab.v4.objects.ProjectVariable`
+ :class:`gitlab.v4.objects.ProjectVariableManager`
+ :attr:`gitlab.v4.objects.Project.variables`
+ :class:`gitlab.v4.objects.GroupVariable`
+ :class:`gitlab.v4.objects.GroupVariableManager`
+ :attr:`gitlab.v4.objects.Group.variables`
* v3 API
+ :class:`gitlab.v3.objects.ProjectVariable`
+ :class:`gitlab.v3.objects.ProjectVariableManager`
+ :attr:`gitlab.v3.objects.Project.variables`
+ :attr:`gitlab.Gitlab.project_variables`
* GitLab API
+ https://docs.gitlab.com/ce/api/project_level_variables.html
+ https://docs.gitlab.com/ce/api/group_level_variables.html
Examples
--------
List variables:
.. literalinclude:: builds.py
:start-after: # var list
:end-before: # end var list
Get a variable:
.. literalinclude:: builds.py
:start-after: # var get
:end-before: # end var get
Create a variable:
.. literalinclude:: builds.py
:start-after: # var create
:end-before: # end var create
Update a variable value:
.. literalinclude:: builds.py
:start-after: # var update
:end-before: # end var update
Remove a variable:
.. literalinclude:: builds.py
:start-after: # var delete
:end-before: # end var delete
Builds/Jobs
===========
Builds/Jobs are associated to projects and commits. They provide information on
the builds/jobs that have been run, and methods to manipulate them.
Reference
---------
* v4 API
+ :class:`gitlab.v4.objects.ProjectJob`
+ :class:`gitlab.v4.objects.ProjectJobManager`
+ :attr:`gitlab.v4.objects.Project.jobs`
* v3 API
+ :class:`gitlab.v3.objects.ProjectJob`
+ :class:`gitlab.v3.objects.ProjectJobManager`
+ :attr:`gitlab.v3.objects.Project.jobs`
+ :attr:`gitlab.Gitlab.project_jobs`
* GitLab API: https://docs.gitlab.com/ce/api/jobs.html
Examples
--------
Jobs are usually automatically triggered, but you can explicitly trigger a new
job:
Trigger a new job on a project:
.. literalinclude:: builds.py
:start-after: # trigger run
:end-before: # end trigger run
List jobs for the project:
.. literalinclude:: builds.py
:start-after: # list
:end-before: # end list
To list builds for a specific commit, create a
:class:`~gitlab.v3.objects.ProjectCommit` object and use its
:attr:`~gitlab.v3.objects.ProjectCommit.builds` method (v3 only):
.. literalinclude:: builds.py
:start-after: # commit list
:end-before: # end commit list
Get a job:
.. literalinclude:: builds.py
:start-after: # get
:end-before: # end get
Get a job artifact:
.. literalinclude:: builds.py
:start-after: # artifacts
:end-before: # end artifacts
.. warning::
Artifacts are entirely stored in memory in this example.
.. _streaming_example:
You can download artifacts as a stream. Provide a callable to handle the
stream:
.. literalinclude:: builds.py
:start-after: # stream artifacts
:end-before: # end stream artifacts
Mark a job artifact as kept when expiration is set:
.. literalinclude:: builds.py
:start-after: # keep artifacts
:end-before: # end keep artifacts
Get a job trace:
.. literalinclude:: builds.py
:start-after: # trace
:end-before: # end trace
.. warning::
Traces are entirely stored in memory unless you use the streaming feature.
See :ref:`the artifacts example <streaming_example>`.
Cancel/retry a job:
.. literalinclude:: builds.py
:start-after: # retry
:end-before: # end retry
Play (trigger) a job:
.. literalinclude:: builds.py
:start-after: # play
:end-before: # end play
Erase a job (artifacts and trace):
.. literalinclude:: builds.py
:start-after: # erase
:end-before: # end erase
|
