1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4 <meta http-equiv=
"content-type" content=
"text/html; charset=utf-8">
5 <title>Releasing Process
</title>
6 <link rel=
"stylesheet" type=
"text/css" href=
"mesa.css">
11 The Mesa
3D Graphics Library
14 <iframe src=
"contents.html"></iframe>
18 <h1>Releasing Process
</h1>
21 <li><a href=
"#overview">Overview
</a>
22 <li><a href=
"#schedule">Release schedule
</a>
23 <li><a href=
"#pickntest">Cherry-pick and test
</a>
24 <li><a href=
"#stagingbranch">Staging branch
</a>
25 <li><a href=
"#branch">Making a branchpoint
</a>
26 <li><a href=
"#prerelease">Pre-release announcement
</a>
27 <li><a href=
"#release">Making a new release
</a>
28 <li><a href=
"#announce">Announce the release
</a>
29 <li><a href=
"#website">Update the mesa3d.org website
</a>
30 <li><a href=
"#bugzilla">Update Bugzilla
</a>
34 <h2 id=
"overview">Overview
</h2>
37 This document uses the convention X.Y.Z for the release number with X.Y being
38 the stable branch name.
40 Mesa provides feature and bugfix releases. Former use zero as patch version (Z),
41 while the latter have a non-zero one.
48 Mesa
10.1.0 -
10.1 branch, feature
49 Mesa
10.1.4 -
10.1 branch, bugfix
50 Mesa
12.0.0 -
12.0 branch, feature
51 Mesa
12.0.2 -
12.0 branch, bugfix
55 <h2 id=
"schedule">Release schedule
</h2>
58 Releases should happen on Wednesdays. Delays can occur although those
59 should be kept to a minimum.
61 See our
<a href=
"release-calendar.html" target=
"_parent">calendar
</a>
62 for information about how the release schedule is planned, and the
63 date and other details for individual releases.
66 <h2>Feature releases
</h2>
68 <li>Available approximately every three months.
69 <li>Initial timeplan available
2-
4 weeks before the planned branchpoint (rc1)
70 on the mesa-announce@ mailing list.
71 <li>Typically, the final release will happen after
4
72 candidates. Additional ones may be needed in order to resolve blocking
74 <li>A
<a href=
"#prerelease">pre-release
</a> announcement should be available
75 approximately
24 hours before the final (non-rc) release.
78 <h2>Stable releases
</h2>
80 <li>Normally available once every two weeks.
81 <li>Only the latest branch has releases. See note below.
82 <li>A
<a href=
"#prerelease">pre-release
</a> announcement should be available
83 approximately
48 hours before the actual release.
87 Note: There is one or two releases overlap when changing branches. For example:
89 The final release from the
12.0 series Mesa
12.0.5 will be out around the same
90 time (or shortly after)
13.0.1 is out.
92 This also involves that, as a final release may be delayed due to the
93 need of additional candidates to solve some blocking regression(s),
94 the release manager might have to update
95 the
<a href=
"release-calendar.html" target=
"_parent">calendar
</a> with
96 additional bug fix releases of the current stable branch.
100 <h2 id=
"pickntest">Cherry-picking and testing
</h2>
103 Commits nominated for the active branch are picked as based on the
104 <a href=
"submittingpatches.html#criteria" target=
"_parent">criteria
</a> as
105 described in the same section.
109 Nomination happens in the mesa-stable@ mailing list. However,
110 maintainer is responsible of checking for forgotten candidates in the
111 master branch. This is achieved by a combination of ad-hoc scripts and
112 a casual search for terms such as regression, fix, broken and similar.
116 Maintainer is also responsible for testing in various possible permutations of
117 the autoconf and scons build.
120 <h2>Cherry-picking and build/check testing
</h2>
122 <p>Done continuously up-to the
<a href=
"#prerelease">pre-release
</a> announcement.
</p>
125 Developers can request,
<em>as an exception
</em>, patches to be applied up-to
126 the last one hour before the actual release. This is made
<strong>only
</strong>
127 with explicit permission/request, and the patch
<strong>must
</strong> be very
128 well contained. Thus it cannot affect more than one driver/subsystem.
131 <p>Following developers have requested permanent exception
</p>
133 <li><em>Ilia Mirkin
</em>
134 <li><em>AMD team
</em>
137 <p>The following must pass:
</p>
139 <li>meson test, scons and scons check
140 <li>Testing with different version of system components - LLVM and others is also
141 performed where possible.
142 <li>As a general rule, testing with various combinations of configure
143 switches, depending on the specific patchset.
147 These are achieved by combination of
<a href=
"basictesting">local testing
</a>,
148 which includes mingw-w64 cross compilation and AppVeyor plus Travis-CI, the
149 latter two as part of their Github integration.
153 For Windows related changes, the main contact point is Brian
154 Paul. Jose Fonseca can also help as a fallback contact.
158 For Android related changes, the main contact is Tapani
159 P
älli. Mauro Rossi is collaborating with android-x86 and may
160 provide feedback about the build status in that project.
164 For MacOSX related changes, Jeremy Huddleston Sequoia is currently a
169 <strong>Note:
</strong> If a patch in the current queue needs any additional
170 fix(es), then they should be squashed together.
172 The commit messages and the
<code>cherry picked from
</code> tags must be preserved.
176 This should be noted in the
<a href=
"#prerelease">pre-announce
</a> email.
180 git show b10859ec41d09c57663a258f43fe57c12332698e
182 commit b10859ec41d09c57663a258f43fe57c12332698e
183 Author: Jonas Pfeil
<pfeiljonas@gmx.de
>
184 Date: Wed Mar
1 18:
11:
10 2017 +
0100
186 ralloc: Make sure ralloc() allocations match malloc()'s alignment.
188 The header of ralloc needs to be aligned, because the compiler assumes
191 (cherry picked from commit cd2b55e536dc806f9358f71db438dd9c246cdb14)
193 Squashed with commit:
195 ralloc: don't leave out the alignment factor
197 Experimentation shows that without alignment factor gcc and clang choose
200 (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
203 <h2>Regression/functionality testing
</h2>
206 Less often (once or twice), shortly before the pre-release announcement.
207 Ensure that testing is redone if Intel devs have requested an exception, as per above.
211 <li><em>no regressions should be observed for Piglit/dEQP/CTS/Vulkan on Intel platforms
</em>
212 <li><em>no regressions should be observed for Piglit using the swrast, softpipe
213 and llvmpipe drivers
</em>
217 Currently 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.
221 Installing the built driver from the pre-announced RC branch in the
222 system and making some every day's use until the release may be a good
226 <h2 id=
"stagingbranch">Staging branch
</h2>
229 A live branch, which contains the currently merge/rejected patches is available
230 in the main repository under
<code>staging/X.Y
</code>. For example:
233 staging/
18.1 - WIP branch for the
18.1 series
234 staging/
18.2 - WIP branch for the
18.2 series
241 <li>People are encouraged to test the staging branch and report regressions.
</li>
242 <li>The branch history is not stable and it
<strong>will
</strong> be rebased,
</li>
246 <h2 id=
"branch">Making a branchpoint
</h2>
249 A branchpoint is made such that new development can continue in parallel to
250 stabilisation and bugfixing.
254 Note: Before doing a branch ensure that basic build and
<code>meson test
</code>
255 testing is done and there are little to-no issues.
257 Ideally all of those should be tackled already.
261 Check if the version number is going to remain as, alternatively
262 <code> git mv docs/relnotes/{current,new}.html
</code> as appropriate.
266 To setup the branchpoint:
269 git checkout master # make sure we're in master first
270 git tag -s X.Y-branchpoint -m
"Mesa X.Y branchpoint"
273 $EDITOR VERSION # bump the version number
275 cp docs/relnotes/{X.Y,X.Y+
1}.html # copy/create relnotes template
277 git push origin X.Y-branchpoint X.Y
282 <a href=
"https://bugs.freedesktop.org/editversions.cgi?action=add&product=Mesa" target=
"_parent">Bugzilla
</a> and add the new Mesa version X.Y.
286 Check that there are no distribution breaking changes and revert them if needed.
287 For example: files being overwritten on install, etc. Happens extremely rarely -
288 we had only one case so far (see commit
2ced8eb136528914e1bf4e000dea06a9d53c7e04).
292 Proceed to
<a href=
"#release">release
</a> -rc1.
296 <h2 id=
"prerelease">Pre-release announcement
</h2>
299 It comes shortly after outstanding patches in the respective branch are pushed.
300 Developers can check, in brief, what's the status of their patches. They,
301 alongside very early testers, are strongly encouraged to test the branch and
302 report any regressions.
304 It is followed by a brief period (normally
24 or
48 hours) before the actual
309 Be aware to add a note to warn about a final release in a series, if
313 <h2>Terminology used
</h2>
315 <ul><li>Nominated
</ul>
318 Patch that is nominated but yet to to merged in the patch queue/branch.
324 Patch is in the queue/branch and will feature in the next release.
325 Barring reported regressions or objections from developers.
328 <ul><li>Rejected
</ul>
331 Patch does not fit the
332 <a href=
"submittingpatches.html#criteria" target=
"_parent">criteria
</a> and
333 is followed by a brief information.
335 The release maintainer is human so if you believe you've spotted a mistake do
339 <h2>Format/template
</h2>
341 Subject: [ANNOUNCE] Mesa X.Y.Z release candidate
342 To: mesa-announce@...
347 The candidate for the Mesa X.Y.Z is now available. Currently we have:
349 - NUMBER nominated (outstanding)
350 - and NUMBER rejected patches
353 Note: this is the final anticipated release in the SERIES series. Users are
354 encouraged to migrate to the NEXT_SERIES series in order to obtain future fixes.]
356 BRIEF SUMMARY OF CHANGES
358 Take a look at section
"Mesa stable queue" for more information.
361 Testing reports/general approval
362 --------------------------------
363 Any testing reports (or general approval of the state of the branch) will be
366 The plan is to have X.Y.Z this DAY (DATE), around or shortly after TIME.
368 If you have any questions or suggestions - be that about the current patch
369 queue or otherwise, please go ahead.
372 Trivial merge conflicts
373 -----------------------
374 List of commits where manual intervention was required.
375 Keep the authors in the CC list.
387 commit
990f395e007c3204639daa34efc3049f350ee819
388 Author: Emil Velikov
<emil.velikov@collabora.com
>
390 anv: automake: cleanup the generated json file during make clean
392 (cherry picked from commit
8df581520a823564be0ab5af7dbb7d501b1c9670)
411 2de85eb radv: fix texturesamples to handle single sample case
426 ralloc: Make sure ralloc() allocations match malloc()'s alignment.
428 ralloc: don't leave out the alignment factor
442 a39ad18 configure.ac: honour LLVM_LIBDIR when linking against LLVM
444 Reason: The patch was reverted shortly after it was merged.
448 <h2 id=
"release">Making a new release
</h2>
451 These are the instructions for making a new Mesa release.
454 <h3>Get latest source files
</h3>
457 Ensure the latest code is available - both in your local master and the
461 <h3 id=
"basictesting">Perform basic testing
</h3>
464 Most of the testing should already be done during the
465 <a href=
"#pickntest">cherry-pick
</a> and
466 <a href=
"#prerelease">pre-announce
</a> stages.
467 So we do a quick 'touch test'
472 <li>scons (from release tarball)
473 <li>the produced binaries work
477 Here is one solution:
481 __glxgears_cmd='glxgears
2>&1 | grep -v
"configuration file"'
482 __es2info_cmd='es2_info
2>&1 | egrep
"GL_VERSION|GL_RENDERER|.*dri\.so"'
483 __es2gears_cmd='es2gears_x11
2>&1 | grep -v
"configuration file"'
484 test
"x$LD_LIBRARY_PATH" != 'x'
&& __old_ld=
"$LD_LIBRARY_PATH"
485 export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/:
"${__old_ld}"
486 export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
487 export LIBGL_DEBUG=verbose
492 export LIBGL_ALWAYS_SOFTWARE=true
497 export LIBGL_ALWAYS_SOFTWARE=true
498 export GALLIUM_DRIVER=softpipe
504 unset LD_LIBRARY_PATH
505 test
"x$__old_ld" != 'x'
&& export
LD_LIBRARY_PATH=
"$__old_ld" && unset __old_ld
506 unset LIBGL_DRIVERS_PATH
508 unset LIBGL_ALWAYS_SOFTWARE
510 export VK_ICD_FILENAMES=`pwd`/src/intel/vulkan/dev_icd.json
511 steam steam://rungameid/
570 -vconsole -vulkan
512 unset VK_ICD_FILENAMES
515 <h3>Update version in file VERSION
</h3>
518 Increment the version contained in the file VERSION at Mesa's top-level, then
522 <h3>Create release notes for the new release
</h3>
525 Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
526 release notes). Note that the sha256sums section of the release notes should
527 be empty (TBD) at this point.
531 Two scripts are available to help generate portions of the release notes:
535 ./bin/bugzilla_mesa.sh
536 ./bin/shortlog_mesa.sh
540 The first script identifies commits that reference bugzilla bugs and obtains
541 the descriptions of those bugs from bugzilla. The second script generates a
542 log of all commits. In both cases, HTML-formatted lists are printed to stdout
543 to be included in the release notes.
547 Commit these changes and push the branch.
555 <h3>Use the release.sh script from xorg
<a href=
"https://cgit.freedesktop.org/xorg/util/modular/">util-modular
</a></h3>
558 Start the release process.
562 # For the dist/distcheck, you may want to specify which LLVM to use:
563 # export LLVM_CONFIG=/usr/lib/llvm-
3.9/bin/llvm-config
564 ../relative/path/to/release.sh . # append --dist if you've already done distcheck above
568 Pay close attention to the prompts as you might be required to enter your GPG
569 and SSH passphrase(s) to sign and upload the files, respectively.
572 <h3>Add the sha256sums to the release notes
</h3>
575 Edit docs/relnotes/X.Y.Z.html to add the sha256sums as available in the mesa-X.Y.Z.announce template. Commit this change.
578 <h3>Back on mesa master, add the new release notes into the tree
</h3>
581 Something like the following steps will do the trick:
585 git cherry-pick -x X.Y~
1
586 git cherry-pick -x X.Y
590 Also, edit docs/relnotes.html to add a link to the new release notes,
591 edit docs/index.html to add a news entry and a note in case of the
592 last release in a series, and remove the version from
593 docs/release-calendar.html. Then commit and push:
597 git commit -as -m
"docs: update calendar, add news item and link release notes for X.Y.Z"
598 git push origin master X.Y
602 <h2 id=
"announce">Announce the release
</h2>
605 Use the generated template during the releasing process.
609 Again, pay attention to add a note to warn about a final release in a
610 series, if that is the case.
614 <h2 id=
"website">Update the mesa3d.org website
</h2>
617 As the hosting was moved to freedesktop, git hooks are deployed to update the
618 website. Manually check that it is updated
5-
10 minutes after the final
<code>git push
</code>
622 <h2 id=
"bugzilla">Update Bugzilla
</h2>
625 Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
628 If there's outstanding action, close the bug referencing the commit ID which
629 addresses the bug and mention the Mesa version that has the fix.
633 Note: the above is not applicable to all the reports, so use common sense.