releasing.rst 10.6 KB
Newer Older
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
Releasing Process
=================

Overview
--------

This document uses the convention X.Y.Z for the release number with X.Y
being the stable branch name.

Mesa provides feature and bugfix releases. Former use zero as patch
version (Z), while the latter have a non-zero one.

For example:

::

   Mesa 10.1.0 - 10.1 branch, feature
   Mesa 10.1.4 - 10.1 branch, bugfix
   Mesa 12.0.0 - 12.0 branch, feature
   Mesa 12.0.2 - 12.0 branch, bugfix

.. _schedule:

Release schedule
----------------

Releases should happen on Wednesdays. Delays can occur although those
should be kept to a minimum.

30
See our :doc:`calendar <release-calendar>` for information about how
31
32
33
34
35
36
37
the release schedule is planned, and the date and other details for
individual releases.

Feature releases
----------------

-  Available approximately every three months.
38
39
-  Feature releases are branched on or around the second Wednesday of
   January, April, July, and October.
Erik Faye-Lund's avatar
Erik Faye-Lund committed
40
-  Initial time plan available 2-4 weeks before the planned branchpoint
41
42
43
44
45
46
47
48
49
50
51
   (rc1) on the mesa-announce@ mailing list.
-  Typically, the final release will happen after 4 candidates.
   Additional ones may be needed in order to resolve blocking
   regressions, though.

Stable releases
---------------

-  Normally available once every two weeks.
-  Only the latest branch has releases. See note below.

52
.. note::
53

54
55
   There is one or two releases overlap when changing branches. For
   example:
56

57
58
59
60
61
62
   The final release from the 12.0 series Mesa 12.0.5 will be out around
   the same time (or shortly after) 13.0.1 is out.

   This also involves that, as a final release may be delayed due to the
   need of additional candidates to solve some blocking regression(s), the
   release manager might have to update the
63
   :doc:`calendar <release-calendar>` with additional bug fix releases of
64
   the current stable branch.
65
66
67
68
69
70
71

.. _pickntest:

Cherry-picking and testing
--------------------------

Commits nominated for the active branch are picked as based on the
72
:ref:`criteria <criteria>` as described in the same
73
74
75
section.

Nominations happen via special tags in the commit messages, and via
Erik Faye-Lund's avatar
Erik Faye-Lund committed
76
GitLab merge requests against the staging branches. There are special
77
78
79
scripts used to read the tags.

The maintainer should watch or be in contact with the Intel CI team, as
Erik Faye-Lund's avatar
Erik Faye-Lund committed
80
well as watch the GitLab CI for regressions.
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

Cherry picking should be done with the '-x' switch (to automatically add
"cherry picked from ..." to the commit message):

``git cherry-pick -x abcdef12345667890``

Developers can request, *as an exception*, patches to be applied up-to
the last one hour before the actual release. This is made **only** with
explicit permission/request, and the patch **must** be very well
contained. Thus it cannot affect more than one driver/subsystem.

Following developers have requested permanent exception

-  *Ilia Mirkin*
-  *AMD team*

Erik Faye-Lund's avatar
Erik Faye-Lund committed
97
The GitLab CI must pass.
98
99
100
101
102

For Windows related changes, the main contact point is Brian Paul. Jose
Fonseca can also help as a fallback contact.

For Android related changes, the main contact is Tapani Pälli. Mauro
Erik Faye-Lund's avatar
Erik Faye-Lund committed
103
Rossi is collaborating with Android-x86 and may provide feedback about
104
105
106
107
108
the build status in that project.

For MacOSX related changes, Jeremy Huddleston Sequoia is currently a
good contact point.

109
110
111
112
113
.. note::

   If a patch in the current queue needs any additional fix(es),
   then they should be squashed together. The commit messages and the
   "``cherry picked from``"-tags must be preserved.
114

115
   .. code-block:: console
116

117
      git show b10859ec41d09c57663a258f43fe57c12332698e
118

119
120
121
      commit b10859ec41d09c57663a258f43fe57c12332698e
      Author: Jonas Pfeil <pfeiljonas@gmx.de>
      Date:   Wed Mar 1 18:11:10 2017 +0100
122

123
         ralloc: Make sure ralloc() allocations match malloc()'s alignment.
124

125
126
         The header of ralloc needs to be aligned, because the compiler assumes
         ...
127

128
         (cherry picked from commit cd2b55e536dc806f9358f71db438dd9c246cdb14)
129

130
         Squashed with commit:
131

132
         ralloc: don't leave out the alignment factor
133

134
135
         Experimentation shows that without alignment factor GCC and Clang choose
         ...
136

137
         (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
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

Regression/functionality testing
--------------------------------

-  *no regressions should be observed for Piglit/dEQP/CTS/Vulkan on
   Intel platforms*
-  *no regressions should be observed for Piglit using the swrast,
   softpipe and llvmpipe drivers*

.. _stagingbranch:

Staging branch
--------------

A live branch, which contains the currently merge/rejected patches is
available in the main repository under ``staging/X.Y``. For example:

::

   staging/18.1 - WIP branch for the 18.1 series
   staging/18.2 - WIP branch for the 18.2 series

Notes:

-  People are encouraged to test the staging branch and report
   regressions.
-  The branch history is not stable and it **will** be rebased,

Making a branchpoint
--------------------

A branchpoint is made such that new development can continue in parallel
170
to stabilization and bugfixing.
171

172
173
174
175
176
.. note::

   Before doing a branch ensure that basic build and ``meson test``
   testing is done and there are little to-no issues. Ideally all of those
   should be tackled already.
177
178
179

To setup the branchpoint:

180
.. code-block:: console
181

182
183
184
185
   git fetch origin # make sure we have the latest commits
   git checkout main # make sure we're on main
   git reset origin # make sure we're at the latest commit

186
   git tag -s X.Y-branchpoint -m "Mesa X.Y branchpoint"
187
188
189
190
191
192
193
194
195
196
197
198

   # Make sure main can carry on at the new version
   $EDITOR VERSION # bump the version number, keeping in mind the wrap around at the end of the year
   git commit -asm 'VERSION: bump to X.(Y+1)'
   truncate -s0 docs/relnotes/new_features.txt
   git commit -asm 'docs: reset new_features.txt'
   git push origin main

   # Create the tag and branches on the server
   git push origin X.Y-branchpoint
   git push origin X.Y-branchpoint:refs/heads/X.Y
   git push origin X.Y-branchpoint:refs/heads/staging/X.Y
199
200

Now go to
Erik Faye-Lund's avatar
Erik Faye-Lund committed
201
`GitLab <https://gitlab.freedesktop.org/mesa/mesa/-/milestones>`__ and
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
add the new Mesa version X.Y.

Check that there are no distribution breaking changes and revert them if
needed. For example: files being overwritten on install, etc. Happens
extremely rarely - we had only one case so far (see commit
2ced8eb136528914e1bf4e000dea06a9d53c7e04).

Making a new release
--------------------

These are the instructions for making a new Mesa release.

Get latest source files
~~~~~~~~~~~~~~~~~~~~~~~

217
Ensure the latest code is available - both in your local main and the
218
219
220
221
222
223
relevant branch.

Perform basic testing
~~~~~~~~~~~~~~~~~~~~~

Most of the testing should already be done during the
224
:ref:`cherry-pick <pickntest>` So we do a quick 'touch test'
225
226
227
228
229
230

-  meson dist
-  the produced binaries work

Here is one solution:

231
.. code-block:: console
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269

   __glxgears_cmd='glxgears 2>&1 | grep -v "configuration file"'
   __es2info_cmd='es2_info 2>&1 | egrep "GL_VERSION|GL_RENDERER|.*dri\.so"'
   __es2gears_cmd='es2gears_x11 2>&1 | grep -v "configuration file"'
   test "x$LD_LIBRARY_PATH" != 'x' && __old_ld="$LD_LIBRARY_PATH"
   export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/:"${__old_ld}"
   export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
   export LIBGL_DEBUG=verbose
   eval $__glxinfo_cmd
   eval $__glxgears_cmd
   eval $__es2info_cmd
   eval $__es2gears_cmd
   export LIBGL_ALWAYS_SOFTWARE=true
   eval $__glxinfo_cmd
   eval $__glxgears_cmd
   eval $__es2info_cmd
   eval $__es2gears_cmd
   export LIBGL_ALWAYS_SOFTWARE=true
   export GALLIUM_DRIVER=softpipe
   eval $__glxinfo_cmd
   eval $__glxgears_cmd
   eval $__es2info_cmd
   eval $__es2gears_cmd
   # Smoke test DOTA2
   unset LD_LIBRARY_PATH
   test "x$__old_ld" != 'x' && export LD_LIBRARY_PATH="$__old_ld" && unset __old_ld
   unset LIBGL_DRIVERS_PATH
   unset LIBGL_DEBUG
   unset LIBGL_ALWAYS_SOFTWARE
   unset GALLIUM_DRIVER
   export VK_ICD_FILENAMES=`pwd`/test/usr/local/share/vulkan/icd.d/intel_icd.x86_64.json
   steam steam://rungameid/570  -vconsole -vulkan
   unset VK_ICD_FILENAMES

Create release notes for the new release
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The release notes are completely generated by the
270
271
272
``bin/gen_release_notes.py`` script. Simply run this script **before**
bumping the version. You'll need to come back to this file once the
tarball is generated to add its ``sha256sum``.
273

274
275
276
Increment the version contained in the file ``VERSION`` at Mesa's top-level,
then commit this change and **push the branch** (if you forget to do
this, ``release.sh`` below will fail).
277

278
279
Use the release.sh script from xorg `util-modular <https://gitlab.freedesktop.org/xorg/util/modular>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
280
281
282

Start the release process.

283
.. code-block:: console
284
285
286
287
288
289
290

   ../relative/path/to/release.sh . # append --dist if you've already done distcheck above

Pay close attention to the prompts as you might be required to enter
your GPG and SSH passphrase(s) to sign and upload the files,
respectively.

291
Ensure that you do sign the tarballs, that your key is mentioned in the
292
293
release notes, and is published in `release-maintainers-keys.asc
<release-maintainers-keys.asc>`__.
294
295


296
297
298
Add the sha256sums to the release notes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

299
300
Edit ``docs/relnotes/X.Y.Z.rst`` to add the ``sha256sum`` as available in the
``mesa-X.Y.Z.announce`` template. Commit this change.
301

302
303
304
305
306
307
308
309
310
Don't forget to push the commits to both the ``staging/X.Y`` branch and
the ``X.Y`` branch:

.. code-block:: console

   git push origin HEAD:staging/X.Y
   git push origin HEAD:X.Y


311
Back on mesa main, add the new release notes into the tree
312
313
314
315
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Something like the following steps will do the trick:

316
.. code-block:: console
317
318
319
320
321
322

   git cherry-pick -x X.Y~1
   git cherry-pick -x X.Y

Then run the

323
.. code-block:: console
324
325
326

   ./bin/post_version.py X.Y.Z

327
, where X.Y.Z is the version you just made. This will update
328
docs/relnotes.rst and docs/release-calendar.csv. It will then generate
Erik Faye-Lund's avatar
Erik Faye-Lund committed
329
a Git commit automatically. Check that everything looks correct and
330
push:
331

332
.. code-block:: console
333

334
      git push origin main X.Y
335
336
337
338
339
340
341
342
343

Announce the release
--------------------

Use the generated template during the releasing process.

Again, pay attention to add a note to warn about a final release in a
series, if that is the case.

Erik Faye-Lund's avatar
Erik Faye-Lund committed
344
Update GitLab issues
345
346
--------------------

347
Parse through the bug reports as listed in the docs/relnotes/X.Y.Z.rst
348
349
350
351
document. If there's outstanding action, close the bug referencing the
commit ID which addresses the bug and mention the Mesa version that has
the fix.

352
.. note: the above is not applicable to all the reports, so use common sense.