releasing.html 16.6 KB
Newer Older
1 2 3 4
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
  <meta http-equiv="content-type" content="text/html; charset=utf-8">
5
  <title>Releasing Process</title>
6 7 8 9 10
  <link rel="stylesheet" type="text/css" href="mesa.css">
</head>
<body>

<div class="header">
11
  The Mesa 3D Graphics Library
12 13 14 15 16
</div>

<iframe src="contents.html"></iframe>
<div class="content">

17

18
<h1>Releasing Process</h1>
19 20 21 22 23

<ul>
<li><a href="#overview">Overview</a>
<li><a href="#schedule">Release schedule</a>
<li><a href="#pickntest">Cherry-pick and test</a>
24
<li><a href="#stagingbranch">Staging branch</a>
25 26 27 28 29 30 31 32
<li><a href="#branch">Making a branchpoint</a>
<li><a href="#prerelease">Pre-release announcement</a>
<li><a href="#release">Making a new release</a>
<li><a href="#announce">Announce the release</a>
<li><a href="#website">Update the mesa3d.org website</a>
<li><a href="#bugzilla">Update Bugzilla</a>
</ul>

33

34
<h2 id="overview">Overview</h2>
35 36 37 38

<p>
This document uses the convention X.Y.Z for the release number with X.Y being
the stable branch name.
39 40 41
</p>

<p>
42 43 44 45 46 47 48 49 50 51 52 53 54 55
Mesa provides feature and bugfix releases. Former use zero as patch version (Z),
while the latter have a non-zero one.
</p>

<p>
For example:
</p>
<pre>
	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
</pre>

56

57
<h2 id="schedule">Release schedule</h2>
58 59

<p>
60
Releases should happen on Wednesdays. Delays can occur although those
61
should be kept to a minimum.
62 63 64
</p>

<p>
65 66
See our <a href="release-calendar.html" target="_parent">calendar</a>
for information about how the release schedule is planned, and the
67
date and other details for individual releases.
68 69 70 71
</p>

<h2>Feature releases</h2>
<ul>
Eric Engestrom's avatar
Eric Engestrom committed
72
<li>Available approximately every three months.
73 74
<li>Initial timeplan available 2-4 weeks before the planned branchpoint (rc1)
on the mesa-announce@ mailing list.
75 76 77
<li>Typically, the final release will happen after 4
candidates. Additional ones may be needed in order to resolve blocking
regressions, though.
78
<li>A <a href="#prerelease">pre-release</a> announcement should be available
Eric Engestrom's avatar
Eric Engestrom committed
79
approximately 24 hours before the final (non-rc) release.
80 81 82 83 84 85 86
</ul>

<h2>Stable releases</h2>
<ul>
<li>Normally available once every two weeks.
<li>Only the latest branch has releases. See note below.
<li>A <a href="#prerelease">pre-release</a> announcement should be available
Eric Engestrom's avatar
Eric Engestrom committed
87
approximately 48 hours before the actual release.
88 89 90 91
</ul>

<p>
Note: There is one or two releases overlap when changing branches. For example:
92 93 94
</p>

<p>
95 96
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.
97 98 99
</p>

<p>
100 101 102 103 104
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 <a href="release-calendar.html" target="_parent">calendar</a> with
additional bug fix releases of the current stable branch.
105 106
</p>

107

108
<h2 id="pickntest">Cherry-picking and testing</h2>
109 110 111 112 113

<p>
Commits nominated for the active branch are picked as based on the
<a href="submittingpatches.html#criteria" target="_parent">criteria</a> as
described in the same section.
114
</p>
115 116

<p>
117
Nomination happens in the mesa-stable@ mailing list. However,
118
maintainer is responsible of checking for forgotten candidates in the
119 120 121 122 123 124
master branch. This is achieved by a combination of ad-hoc scripts and
a casual search for terms such as regression, fix, broken and similar.
</p>

<p>
Maintainer is also responsible for testing in various possible permutations of
125
the meson and scons build.
126 127 128 129 130 131 132
</p>

<h2>Cherry-picking and build/check testing</h2>

<p>Done continuously up-to the <a href="#prerelease">pre-release</a> announcement.</p>

<p>
133 134 135 136
Developers can request, <em>as an exception</em>, patches to be applied up-to
the last one hour before the actual release. This is made <strong>only</strong>
with explicit permission/request, and the patch <strong>must</strong> be very
well contained. Thus it cannot affect more than one driver/subsystem.
137
</p>
138

139 140 141 142 143
<p>Following developers have requested permanent exception</p>
<ul>
<li><em>Ilia Mirkin</em>
<li><em>AMD team</em>
</ul>
144

145
<p>The following must pass:</p>
146
<ul>
147
<li>meson test, scons and scons check
148 149
<li>Testing with different version of system components - LLVM and others is also
performed where possible.
150 151
<li>As a general rule, testing with various combinations of configure
switches, depending on the specific patchset.
152
</ul>
153

154
<p>
155 156 157
These are achieved by combination of <a href="basictesting">local testing</a>,
which includes mingw-w64 cross compilation and AppVeyor plus Travis-CI, the
latter two as part of their Github integration.
158
</p>
159

160 161 162 163 164
<p>
For Windows related changes, the main contact point is Brian
Paul. Jose Fonseca can also help as a fallback contact.
</p>

165 166 167 168 169 170
<p>
For Android related changes, the main contact is Tapani
P&auml;lli. Mauro Rossi is collaborating with android-x86 and may
provide feedback about the build status in that project.
</p>

171 172 173 174 175
<p>
For MacOSX related changes, Jeremy Huddleston Sequoia is currently a
good contact point.
</p>

176 177
<p>
<strong>Note:</strong> If a patch in the current queue needs any additional
178
fix(es), then they should be squashed together. The commit messages and the
179
&quot;<code>cherry picked from</code>&quot;-tags must be preserved.
180
</p>
181

182 183
<p>
This should be noted in the <a href="#prerelease">pre-announce</a> email.
184 185
</p>

186 187 188 189
<pre>
    git show b10859ec41d09c57663a258f43fe57c12332698e

    commit b10859ec41d09c57663a258f43fe57c12332698e
190
    Author: Jonas Pfeil &lt;pfeiljonas@gmx.de&gt;
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    Date:   Wed Mar 1 18:11:10 2017 +0100

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

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

        (cherry picked from commit cd2b55e536dc806f9358f71db438dd9c246cdb14)

        Squashed with commit:

        ralloc: don't leave out the alignment factor

        Experimentation shows that without alignment factor gcc and clang choose
        ...

        (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
</pre>
209 210 211 212 213 214 215

<h2>Regression/functionality testing</h2>

<p>
Less often (once or twice), shortly before the pre-release announcement.
Ensure that testing is redone if Intel devs have requested an exception, as per above.
</p>
216

217 218 219 220 221
<ul>
<li><em>no regressions should be observed for Piglit/dEQP/CTS/Vulkan on Intel platforms</em>
<li><em>no regressions should be observed for Piglit using the swrast, softpipe
and llvmpipe drivers</em>
</ul>
222

223 224 225 226
<p>
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.
</p>

227 228 229 230 231 232
<p>
Installing the built driver from the pre-announced RC branch in the
system and making some every day's use until the release may be a good
idea too.
</p>

233
<h2 id="stagingbranch">Staging branch</h2>
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

<p>
A live branch, which contains the currently merge/rejected patches is available
in the main repository under <code>staging/X.Y</code>. For example:
</p>
<pre>
	staging/18.1 - WIP branch for the 18.1 series
	staging/18.2 - WIP branch for the 18.2 series
</pre>

<p>
Notes:
</p>
<ul>
<li>People are encouraged to test the staging branch and report regressions.</li>
<li>The branch history is not stable and it <strong>will</strong> be rebased,</li>
</ul>

252

253
<h2 id="branch">Making a branchpoint</h2>
254 255 256 257 258 259 260

<p>
A branchpoint is made such that new development can continue in parallel to
stabilisation and bugfixing.
</p>

<p>
261
Note: Before doing a branch ensure that basic build and <code>meson test</code>
262 263
testing is done and there are little to-no issues. Ideally all of those should
be tackled already.
264 265 266 267 268 269 270 271 272 273 274 275 276 277
</p>

<p>
Check if the version number is going to remain as, alternatively
<code> git mv docs/relnotes/{current,new}.html </code> as appropriate.
</p>

<p>
To setup the branchpoint:
</p>
<pre>
	git checkout master # make sure we're in master first
	git tag -s X.Y-branchpoint -m "Mesa X.Y branchpoint"
	git checkout -b X.Y
278 279 280
	git checkout master
	$EDITOR VERSION # bump the version number
	git commit -as
281 282
	cp docs/relnotes/{X.Y,X.Y+1}.html # copy/create relnotes template
	git commit -as
283 284 285 286 287 288 289
	git push origin X.Y-branchpoint X.Y
</pre>

<p>
Now go to
<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.
</p>
290

291
<p>
292 293 294
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).
295
</p>
296

297 298 299 300
<p>
Proceed to <a href="#release">release</a> -rc1.
</p>

301

302
<h2 id="prerelease">Pre-release announcement</h2>
303 304 305 306 307 308

<p>
It comes shortly after outstanding patches in the respective branch are pushed.
Developers can check, in brief, what's the status of their patches. They,
alongside very early testers, are strongly encouraged to test the branch and
report any regressions.
309 310
</p>
<p>
311 312 313 314
It is followed by a brief period (normally 24 or 48 hours) before the actual
release is made.
</p>

315 316 317 318 319
<p>
Be aware to add a note to warn about a final release in a series, if
that is the case.
</p>

320
<h2>Terminology used</h2>
321

322
<ul><li>Nominated</ul>
323

324 325 326 327 328
<p>
Patch that is nominated but yet to to merged in the patch queue/branch.
</p>

<ul><li>Queued</ul>
329

330 331 332 333 334 335
<p>
Patch is in the queue/branch and will feature in the next release.
Barring reported regressions or objections from developers.
</p>

<ul><li>Rejected</ul>
336

337 338 339
<p>
Patch does not fit the
<a href="submittingpatches.html#criteria" target="_parent">criteria</a> and
340 341
is followed by a brief information. The release maintainer is human so if you
believe you've spotted a mistake do let them know.
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
</p>

<h2>Format/template</h2>
<pre>
Subject: [ANNOUNCE] Mesa X.Y.Z release candidate
To: mesa-announce@...
Cc: mesa-dev@...

Hello list,

The candidate for the Mesa X.Y.Z is now available. Currently we have:
 - NUMBER queued
 - NUMBER nominated (outstanding)
 - and NUMBER rejected patches

357 358 359 360
[If applicable:
Note: this is the final anticipated release in the SERIES series. Users are
encouraged to migrate to the NEXT_SERIES series in order to obtain future fixes.]

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
BRIEF SUMMARY OF CHANGES

Take a look at section "Mesa stable queue" for more information.


Testing reports/general approval
--------------------------------
Any testing reports (or general approval of the state of the branch) will be
greatly appreciated.

The plan is to have X.Y.Z this DAY (DATE), around or shortly after TIME.

If you have any questions or suggestions - be that about the current patch
queue or otherwise, please go ahead.


Trivial merge conflicts
-----------------------
List of commits where manual intervention was required.
Keep the authors in the CC list.

commit SHA
Author: AUTHOR

    COMMIT SUMMARY

    CHERRY PICKED FROM


For example:

commit 990f395e007c3204639daa34efc3049f350ee819
Author: Emil Velikov &lt;emil.velikov@collabora.com&gt;

    anv: automake: cleanup the generated json file during make clean

    (cherry picked from commit 8df581520a823564be0ab5af7dbb7d501b1c9670)


Cheers,
Emil


Mesa stable queue
-----------------

Nominated (NUMBER)
==================

AUTHOR (NUMBER):
      SHA     COMMIT SUMMARY

For example:

Dave Airlie (1):
      2de85eb radv: fix texturesamples to handle single sample case


Queued (NUMBER)
===============

AUTHOR (NUMBER):
      COMMIT SUMMARY
424 425 426
[If applicable:
Squashed with
      COMMIT SUMMARY]
427

428 429 430 431 432 433
For example:

Jonas Pfeil (1):
      ralloc: Make sure ralloc() allocations match malloc()'s alignment.
Squashed with
      ralloc: don't leave out the alignment factor
434

435

436 437 438 439 440 441 442
Rejected (NUMBER)
=================

AUTHOR (NUMBER):
      SHA     COMMIT SUMMARY

Reason: ...
443 444 445 446 447 448 449

For example:

Emil Velikov (1)
      a39ad18 configure.ac: honour LLVM_LIBDIR when linking against LLVM

Reason: The patch was reverted shortly after it was merged.
450 451
</pre>

452

453
<h2 id="release">Making a new release</h2>
454 455 456 457 458 459

<p>
These are the instructions for making a new Mesa release.
</p>

<h3>Get latest source files</h3>
460

461 462 463 464 465
<p>
Ensure the latest code is available - both in your local master and the
relevant branch.
</p>

466
<h3 id="basictesting">Perform basic testing</h3>
467

468 469 470 471 472
<p>
Most of the testing should already be done during the
<a href="#pickntest">cherry-pick</a> and
<a href="#prerelease">pre-announce</a> stages.
So we do a quick 'touch test'
473 474
</p>

475
<ul>
476
<li>meson dist
477 478 479 480 481
<li>scons (from release tarball)
<li>the produced binaries work
</ul>

<p>
482
  Here is one solution:
483 484 485
</p>

<pre>
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
    __glxgears_cmd='glxgears 2&gt;&amp;1 | grep -v "configuration file"'
    __es2info_cmd='es2_info 2&gt;&amp;1 | egrep "GL_VERSION|GL_RENDERER|.*dri\.so"'
    __es2gears_cmd='es2gears_x11 2&gt;&amp;1 | grep -v "configuration file"'
    test "x$LD_LIBRARY_PATH" != 'x' &amp;&amp; __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' &amp;&amp; export LD_LIBRARY_PATH="$__old_ld" &amp;&amp; unset __old_ld
    unset LIBGL_DRIVERS_PATH
    unset LIBGL_DEBUG
    unset LIBGL_ALWAYS_SOFTWARE
    unset GALLIUM_DRIVER
515
    export VK_ICD_FILENAMES=`pwd`/test/usr/local/share/vulkan/icd.d/intel_icd.x86_64.json
516 517
    steam steam://rungameid/570  -vconsole -vulkan
    unset VK_ICD_FILENAMES
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
</pre>

<h3>Update version in file VERSION</h3>

<p>
Increment the version contained in the file VERSION at Mesa's top-level, then
commit this change.
</p>

<h3>Create release notes for the new release</h3>

<p>
Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
release notes). Note that the sha256sums section of the release notes should
be empty (TBD) at this point.
</p>

<p>
Two scripts are available to help generate portions of the release notes:
537
</p>
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553

<pre>
	./bin/bugzilla_mesa.sh
	./bin/shortlog_mesa.sh
</pre>

<p>
The first script identifies commits that reference bugzilla bugs and obtains
the descriptions of those bugs from bugzilla. The second script generates a
log of all commits. In both cases, HTML-formatted lists are printed to stdout
to be included in the release notes.
</p>

<p>
Commit these changes and push the branch.
</p>
554

555 556 557 558 559
<pre>
	git push origin HEAD
</pre>


560
<h3>Use the release.sh script from xorg <a href="https://cgit.freedesktop.org/xorg/util/modular/">util-modular</a></h3>
561 562

<p>
563
Start the release process.
564
</p>
565

566
<pre>
567 568
	# For the dist/distcheck, you may want to specify which LLVM to use:
	# export LLVM_CONFIG=/usr/lib/llvm-3.9/bin/llvm-config
569 570 571 572 573 574 575 576 577 578 579
	../relative/path/to/release.sh . # append --dist if you've already done distcheck above
</pre>

<p>
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.
</p>

<h3>Add the sha256sums to the release notes</h3>

<p>
Eric Engestrom's avatar
Eric Engestrom committed
580
Edit docs/relnotes/X.Y.Z.html to add the sha256sums as available in the mesa-X.Y.Z.announce template. Commit this change.
581 582 583 584 585 586 587 588 589 590 591 592 593 594
</p>

<h3>Back on mesa master, add the new release notes into the tree</h3>

<p>
Something like the following steps will do the trick:
</p>

<pre>
	git cherry-pick -x X.Y~1
	git cherry-pick -x X.Y
</pre>

<p>
595
Also, edit docs/relnotes.html to add a link to the new release notes,
596 597
edit docs/index.html to add a news entry and a note in case of the
last release in a series, and remove the version from
598
docs/release-calendar.html. Then commit and push:
599 600 601
</p>

<pre>
602
	git commit -as -m "docs: update calendar, add news item and link release notes for X.Y.Z"
603 604 605 606
	git push origin master X.Y
</pre>


607
<h2 id="announce">Announce the release</h2>
608

609 610 611 612
<p>
Use the generated template during the releasing process.
</p>

613 614 615 616 617
<p>
Again, pay attention to add a note to warn about a final release in a
series, if that is the case.
</p>

618

619
<h2 id="website">Update the mesa3d.org website</h2>
620 621

<p>
622 623
As the hosting was moved to freedesktop, git hooks are deployed to update the
website. Manually check that it is updated 5-10 minutes after the final <code>git push</code>
624 625
</p>

626

627
<h2 id="bugzilla">Update Bugzilla</h2>
628 629 630

<p>
Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
631 632
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.
633 634 635 636 637 638 639 640 641 642
</p>

<p>
Note: the above is not applicable to all the reports, so use common sense.
</p>


</div>
</body>
</html>