Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / 03f4982c684da33e621744acda52730ed05df1bd / . / docs / releasing.html
blob: 09ef4ac89cb39a31db6dc5c4b4ded7fce1c34de6 [file] [log] [blame]
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html lang="en">
3<head>
4 <meta http-equiv="content-type" content="text/html; charset=utf-8">
Emil Velikov028d29b2016-11-28 17:22:15 +0000[diff] [blame]5 <title>Releasing process</title>
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]6 <link rel="stylesheet" type="text/css" href="mesa.css">
7</head>
8<body>
9
10<div class="header">
11 <h1>The Mesa 3D Graphics Library</h1>
12</div>
13
14<iframe src="contents.html"></iframe>
15<div class="content">
16
17<h1>Releasing process</h1>
18
19<ul>
20<li><a href="#overview">Overview</a>
21<li><a href="#schedule">Release schedule</a>
22<li><a href="#pickntest">Cherry-pick and test</a>
23<li><a href="#branch">Making a branchpoint</a>
24<li><a href="#prerelease">Pre-release announcement</a>
25<li><a href="#release">Making a new release</a>
26<li><a href="#announce">Announce the release</a>
27<li><a href="#website">Update the mesa3d.org website</a>
28<li><a href="#bugzilla">Update Bugzilla</a>
29</ul>
30
31<h1 id="overview">Overview</h1>
32
33<p>
34This document uses the convention X.Y.Z for the release number with X.Y being
35the stable branch name.
36<br>
37Mesa provides feature and bugfix releases. Former use zero as patch version (Z),
38while the latter have a non-zero one.
39</p>
40
41<p>
42For example:
43</p>
44<pre>
45 Mesa 10.1.0 - 10.1 branch, feature
46 Mesa 10.1.4 - 10.1 branch, bugfix
47 Mesa 12.0.0 - 12.0 branch, feature
48 Mesa 12.0.2 - 12.0 branch, bugfix
49</pre>
50
51<h1 id="schedule">Release schedule</h1>
52
53<p>
54Releases should happen on Fridays. Delays can occur although those should be keep
55to a minimum.
56</p>
57
58<h2>Feature releases</h2>
59<ul>
60<li>Available approximatelly every three months.
61<li>Initial timeplan available 2-4 weeks before the planned branchpoint (rc1)
62on the mesa-announce@ mailing list.
63<li>A <a href="#prerelease">pre-release</a> announcement should be available
64approximatelly 24 hours before the final (non-rc) release.
65</ul>
66
67<h2>Stable releases</h2>
68<ul>
69<li>Normally available once every two weeks.
70<li>Only the latest branch has releases. See note below.
71<li>A <a href="#prerelease">pre-release</a> announcement should be available
72approximatelly 48 hours before the actual release.
73</ul>
74
75<p>
76Note: There is one or two releases overlap when changing branches. For example:
77<br>
78The final release from the 12.0 series Mesa 12.0.5 will be out around the same
79time (or shortly after) 13.0.1 is out.
80</p>
81
82<h1 id="pickntest">Cherry-picking and testing</h1>
83
84<p>
85Commits nominated for the active branch are picked as based on the
86<a href="submittingpatches.html#criteria" target="_parent">criteria</a> as
87described in the same section.
88
89<p>
90Maintainer is responsible for testing in various possible permutations of
91the autoconf and scons build.
92</p>
93
94<h2>Cherry-picking and build/check testing</h2>
95
96<p>Done continuously up-to the <a href="#prerelease">pre-release</a> announcement.</p>
97
98<p>
99As an exception, patches can be applied up-to the last ~1h before the actual
100release. This is made <strong>only</strong> with explicit permission/request,
101and the patch <strong>must</strong> be very well contained. Thus it cannot
102affect more than one driver/subsystem.
103</p>
104<p>
105Currently Ilia Mirkin and AMD devs have requested "permanent" exception.
106</p>
107
108
109<ul>
110<li>make distcheck, scons and scons check must pass
111<li>Testing with different version of system components - LLVM and others is also
112performed where possible.
113</ul>
114<p>
115Achieved by combination of local ad-hoc scripts and AppVeyor plus Travis-CI,
116the latter as part of their Github integration.
117</p>
118
119<h2>Regression/functionality testing</h2>
120
121<p>
122Less often (once or twice), shortly before the pre-release announcement.
123Ensure that testing is redone if Intel devs have requested an exception, as per above.
124</p>
125<ul>
126<li><em>no regressions should be observed for Piglit/dEQP/CTS/Vulkan on Intel platforms</em>
127<li><em>no regressions should be observed for Piglit using the swrast, softpipe
128and llvmpipe drivers</em>
129</ul>
130<p>
131Currently testing is performed courtesy of the Intel OTC team and their Jenkins CI setup. Check with the Intel team over IRC how to get things setup.
132</p>
133
134
135<h1 id="branch">Making a branchpoint</h1>
136
137<p>
138A branchpoint is made such that new development can continue in parallel to
139stabilisation and bugfixing.
140</p>
141
142<p>
143Note: Before doing a branch ensure that basic build and <code>make check</code>
144testing is done and there are little to-no issues.
145<br>
146Ideally all of those should be tackled already.
147</p>
148
149<p>
150Check if the version number is going to remain as, alternatively
151<code> git mv docs/relnotes/{current,new}.html </code> as appropriate.
152</p>
153
154<p>
155To setup the branchpoint:
156</p>
157<pre>
158 git checkout master # make sure we're in master first
159 git tag -s X.Y-branchpoint -m "Mesa X.Y branchpoint"
160 git checkout -b X.Y
Emil Velikov0f8afde2017-01-19 15:35:38 +0000[diff] [blame]161 git checkout master
162 $EDITOR VERSION # bump the version number
163 git commit -as
Emil Velikov1d104f92017-01-26 19:26:13 +0000[diff] [blame]164 cp docs/relnotes/{X.Y,X.Y+1}.html # copy/create relnotes template
165 git commit -as
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]166 git push origin X.Y-branchpoint X.Y
167</pre>
168
169<p>
170Now go to
171<a href="https://bugs.freedesktop.org/editversions.cgi?action=add&amp;product=Mesa" target="_parent">Bugzilla</a> and add the new Mesa version X.Y.
172</p>
173<p>
174Check for rare that there are no distribution breaking changes and revert them
175if needed. Extremely rare - we had only one case so far (see
176commit 2ced8eb136528914e1bf4e000dea06a9d53c7e04).
177</p>
178<p>
179Proceed to <a href="#release">release</a> -rc1.
180</p>
181
182<h1 id="prerelease">Pre-release announcement</h1>
183
184<p>
185It comes shortly after outstanding patches in the respective branch are pushed.
186Developers can check, in brief, what's the status of their patches. They,
187alongside very early testers, are strongly encouraged to test the branch and
188report any regressions.
189<br>
190It is followed by a brief period (normally 24 or 48 hours) before the actual
191release is made.
192</p>
193
194<h2>Terminology used</h2>
195<ul><li>Nominated</ul>
196<p>
197Patch that is nominated but yet to to merged in the patch queue/branch.
198</p>
199
200<ul><li>Queued</ul>
201<p>
202Patch is in the queue/branch and will feature in the next release.
203Barring reported regressions or objections from developers.
204</p>
205
206<ul><li>Rejected</ul>
207<p>
208Patch does not fit the
209<a href="submittingpatches.html#criteria" target="_parent">criteria</a> and
210is followed by a brief information.
211<br>
212The release maintainer is human so if you believe you've spotted a mistake do
213let them know.
214</p>
215
216<h2>Format/template</h2>
217<pre>
218Subject: [ANNOUNCE] Mesa X.Y.Z release candidate
219To: mesa-announce@...
220Cc: mesa-dev@...
221
222Hello list,
223
224The candidate for the Mesa X.Y.Z is now available. Currently we have:
225 - NUMBER queued
226 - NUMBER nominated (outstanding)
227 - and NUMBER rejected patches
228
229BRIEF SUMMARY OF CHANGES
230
231Take a look at section "Mesa stable queue" for more information.
232
233
234Testing reports/general approval
235--------------------------------
236Any testing reports (or general approval of the state of the branch) will be
237greatly appreciated.
238
239The plan is to have X.Y.Z this DAY (DATE), around or shortly after TIME.
240
241If you have any questions or suggestions - be that about the current patch
242queue or otherwise, please go ahead.
243
244
245Trivial merge conflicts
246-----------------------
247List of commits where manual intervention was required.
248Keep the authors in the CC list.
249
250commit SHA
251Author: AUTHOR
252
253 COMMIT SUMMARY
254
255 CHERRY PICKED FROM
256
257
258For example:
259
260commit 990f395e007c3204639daa34efc3049f350ee819
261Author: Emil Velikov &lt;emil.velikov@collabora.com&gt;
262
263 anv: automake: cleanup the generated json file during make clean
264
265 (cherry picked from commit 8df581520a823564be0ab5af7dbb7d501b1c9670)
266
267
268Cheers,
269Emil
270
271
272Mesa stable queue
273-----------------
274
275Nominated (NUMBER)
276==================
277
278AUTHOR (NUMBER):
279 SHA COMMIT SUMMARY
280
281For example:
282
283Dave Airlie (1):
284 2de85eb radv: fix texturesamples to handle single sample case
285
286
287Queued (NUMBER)
288===============
289
290AUTHOR (NUMBER):
291 COMMIT SUMMARY
292
293
294Rejected (NUMBER)
295=================
296
297Rejected (11)
298=============
299
300AUTHOR (NUMBER):
301 SHA COMMIT SUMMARY
302
303Reason: ...
304</pre>
305
306<h1 id="release">Making a new release</h1>
307
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]308<p>
309These are the instructions for making a new Mesa release.
310</p>
311
312<h3>Get latest source files</h3>
313<p>
314Ensure the latest code is available - both in your local master and the
315relevant branch.
316</p>
317
318<h3>Perform basic testing</h3>
319<p>
320Most of the testing should already be done during the
321<a href="#pickntest">cherry-pick</a> and
322<a href="#prerelease">pre-announce</a> stages.
323
324So we do a quick 'touch test'
325<ul>
326<li>make distcheck (you can omit this if you're not using --dist below)
327<li>scons (from release tarball)
328<li>the produced binaries work
329</ul>
330
331<p>
332Here is one solution that I've been using.
333</p>
334
335<pre>
336 git clean -fXd; git clean -nxd
337 read # quick cross check any outstanding files
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]338 export __version=`cat VERSION`
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]339 export __mesa_root=../
340 export __build_root=./foo
341 chmod 755 -fR $__build_root; rm -rf $__build_root
342 mkdir -p $__build_root &amp;&amp; cd $__build_root
343
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]344 $__mesa_root/autogen.sh --enable-llvm-shared-libs &amp;&amp; make -j2 distcheck
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]345
346 # Build check the tarballs (scons)
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]347 tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version &amp;&amp; scons &amp;&amp; cd ..
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]348
349 # Test the automake binaries
Emil Velikov9924cde2017-01-24 00:58:54 +0000[diff] [blame]350 rm -rf mesa-$__version
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]351 tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]352 ./configure \
353 --with-dri-drivers=i965,swrast \
354 --with-gallium-drivers=swrast \
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]355 --with-vulkan-drivers=intel \
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]356 --enable-llvm-shared-libs \
Emil Velikovb3b41562017-02-07 15:53:14 +0000[diff] [blame]357 --enable-llvm \
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]358 --enable-glx-tls \
359 --enable-gbm \
360 --enable-egl \
361 --with-egl-platforms=x11,drm,wayland
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]362 make -j2 &amp;&amp; DESTDIR=`pwd`/test make -j6 install
363 export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/
364 export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]365 export LIBGL_DEBUG=verbose
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]366 glxinfo | egrep -o "Mesa.*"
367 glxgears
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]368 es2_info | egrep "GL_VERSION|GL_RENDERER"
369 es2gears_x11
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]370 export LIBGL_ALWAYS_SOFTWARE=1
371 glxinfo | egrep -o "Mesa.*|Gallium.*"
372 glxgears
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]373 es2_info | egrep "GL_VERSION|GL_RENDERER"
374 es2gears_x11
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]375 export LIBGL_ALWAYS_SOFTWARE=1
376 export GALLIUM_DRIVER=softpipe
377 glxinfo | egrep -o "Mesa.*|Gallium.*"
378 glxgears
Emil Velikovf9959ca2016-11-28 17:18:06 +0000[diff] [blame]379 es2_info | egrep "GL_VERSION|GL_RENDERER"
380 es2gears_x11
381 # Smoke test DOTA2
382 unset LD_LIBRARY_PATH
383 unset LIBGL_DRIVERS_PATH
384 unset LIBGL_DEBUG
385 unset LIBGL_ALWAYS_SOFTWARE
386 export VK_ICD_FILENAMES=`pwd`/src/intel/vulkan/dev_icd.json
387 steam steam://rungameid/570 -vconsole -vulkan
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]388</pre>
389
390<h3>Update version in file VERSION</h3>
391
392<p>
393Increment the version contained in the file VERSION at Mesa's top-level, then
394commit this change.
395</p>
396
397<h3>Create release notes for the new release</h3>
398
399<p>
400Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
401release notes). Note that the sha256sums section of the release notes should
402be empty (TBD) at this point.
403</p>
404
405<p>
406Two scripts are available to help generate portions of the release notes:
407
408<pre>
409 ./bin/bugzilla_mesa.sh
410 ./bin/shortlog_mesa.sh
411</pre>
412
413<p>
414The first script identifies commits that reference bugzilla bugs and obtains
415the descriptions of those bugs from bugzilla. The second script generates a
416log of all commits. In both cases, HTML-formatted lists are printed to stdout
417to be included in the release notes.
418</p>
419
420<p>
421Commit these changes and push the branch.
422</p>
423<pre>
424 git push origin HEAD
425</pre>
426
427
428<h3>Use the release.sh script from xorg util-macros</h3>
429
430<p>
Emil Velikov2edc29a2016-11-16 18:25:41 +0000[diff] [blame]431Ensure that the mesa git tree is clean via <code>git clean -fXd</code> and
432start the release process.
433</p>
434<pre>
435 ../relative/path/to/release.sh . # append --dist if you've already done distcheck above
436</pre>
437
438<p>
439Pay close attention to the prompts as you might be required to enter your GPG
440and SSH passphrase(s) to sign and upload the files, respectively.
441</p>
442
443<h3>Add the sha256sums to the release notes</h3>
444
445<p>
446Edit docs/relnotes/X.Y.Z.html to add the sha256sums as availabe in the mesa-X.Y.Z.announce template. Commit this change.
447</p>
448
449<h3>Back on mesa master, add the new release notes into the tree</h3>
450
451<p>
452Something like the following steps will do the trick:
453</p>
454
455<pre>
456 git cherry-pick -x X.Y~1
457 git cherry-pick -x X.Y
458</pre>
459
460<p>
461Also, edit docs/relnotes.html to add a link to the new release notes, and edit
462docs/index.html to add a news entry. Then commit and push:
463</p>
464
465<pre>
466 git commit -as -m "docs: add news item and link release notes for X.Y.Z"
467 git push origin master X.Y
468</pre>
469
470
471<h1 id="announce">Announce the release</h1>
472<p>
473Use the generated template during the releasing process.
474</p>
475
476
477<h1 id="website">Update the mesa3d.org website</h1>
478
479<p>
480NOTE: The recent release managers have not been performing this step
481themselves, but leaving this to Brian Paul, (who has access to the
482sourceforge.net hosting for mesa3d.org). Brian is more than willing to grant
483the permission necessary to future release managers to do this step on their
484own.
485</p>
486
487<p>
488Update the web site by copying the docs/ directory's files to
489/home/users/b/br/brianp/mesa-www/htdocs/ with:
490<br>
491<code>
492sftp USERNAME,mesa3d@web.sourceforge.net
493</code>
494</p>
495
496
497<h1 id="bugzilla">Update Bugzilla</h1>
498
499<p>
500Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
501document.
502<br>
503If there's outstanding action, close the bug referencing the commit ID which
504addresses the bug and mention the Mesa version that has the fix.
505</p>
506
507<p>
508Note: the above is not applicable to all the reports, so use common sense.
509</p>
510
511
512</div>
513</body>
514</html>