blob: b20ca77b78b7411f5a93be7b28d80e5c52c19125 (
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
|
######
Builds
######
Build triggers
==============
Build triggers provide a way to interact with the GitLab CI. Using a trigger a
user or an application can run a new build for a specific commit.
* Object class: :class:`~gitlab.objects.ProjectTrigger`
* Manager objects: :attr:`gitlab.Gitlab.project_triggers`,
:attr:`Project.triggers <gitlab.objects.Project.triggers>`
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
Build variables
===============
You can associate variables to builds to modify the build script behavior.
* Object class: :class:`~gitlab.objects.ProjectVariable`
* Manager objects: :attr:`gitlab.Gitlab.project_variables`,
:attr:`gitlab.objects.Project.variables`
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
======
Builds are associated to projects and commits. They provide information on the
build that have been run, and methods to manipulate those builds.
* Object class: :class:`~gitlab.objects.ProjectBuild`
* Manager objects: :attr:`gitlab.Gitlab.project_builds`,
:attr:`gitlab.objects.Project.builds`
Examples
--------
Build are usually automatically triggered, but you can explicitly trigger a
new build:
Trigger a new build on a project:
.. literalinclude:: builds.py
:start-after: # trigger run
:end-before: # end trigger run
List builds for the project:
.. literalinclude:: builds.py
:start-after: # list
:end-before: # end list
To list builds for a specific commit, create a
:class:`~gitlab.objects.ProjectCommit` object and use its
:attr:`~gitlab.objects.ProjectCommit.builds` method:
.. literalinclude:: builds.py
:start-after: # commit list
:end-before: # end commit list
Get a build:
.. literalinclude:: builds.py
:start-after: # get
:end-before: # end get
Get a build artifacts:
.. 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 build artifact as kept when expiration is set:
.. literalinclude:: builds.py
:start-after: # keep artifacts
:end-before: # end keep artifacts
Get a build 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 build:
.. literalinclude:: builds.py
:start-after: # retry
:end-before: # end retry
Play (trigger) a build:
.. literalinclude:: builds.py
:start-after: # play
:end-before: # end play
Erase a build (artifacts and trace):
.. literalinclude:: builds.py
:start-after: # erase
:end-before: # end erase
|
