docs/releasing.html

   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">
   5   <title>Releasing process</title>
   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
  18 <h1>Releasing process</h1>
  19
  20 <ul>
  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>
  31 </ul>
  32
  33
  34 <h1 id="overview">Overview</h1>
  35
  36 <p>
  37 This document uses the convention X.Y.Z for the release number with X.Y being
  38 the stable branch name.
  39 <br>
  40 Mesa provides feature and bugfix releases. Former use zero as patch version (Z),
  41 while the latter have a non-zero one.
  42 </p>
  43
  44 <p>
  45 For example:
  46 </p>
  47 <pre>
  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
  52 </pre>
  53
  54
  55 <h1 id="schedule">Release schedule</h1>
  56
  57 <p>
  58 Releases should happen on Wednesdays. Delays can occur although those
  59 should be kept to a minimum.
  60 <br>
  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.
  64 </p>
  65
  66 <h2>Feature releases</h2>
  67 <ul>
  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
  73 regressions, though.
  74 <li>A <a href="#prerelease">pre-release</a> announcement should be available
  75 approximately 24 hours before the final (non-rc) release.
  76 </ul>
  77
  78 <h2>Stable releases</h2>
  79 <ul>
  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.
  84 </ul>
  85
  86 <p>
  87 Note: There is one or two releases overlap when changing branches. For example:
  88 <br>
  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.
  91 <br>
  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.
  97 </p>
  98
  99
 100 <h1 id="pickntest">Cherry-picking and testing</h1>
 101
 102 <p>
 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.
 106 </p>
 107
 108 <p>
 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.
 113 </p>
 114
 115 <p>
 116 Maintainer is also responsible for testing in various possible permutations of
 117 the autoconf and scons build.
 118 </p>
 119
 120 <h2>Cherry-picking and build/check testing</h2>
 121
 122 <p>Done continuously up-to the <a href="#prerelease">pre-release</a> announcement.</p>
 123
 124 <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.
 129 </p>
 130
 131 <p>Following developers have requested permanent exception</p>
 132 <ul>
 133 <li><em>Ilia Mirkin</em>
 134 <li><em>AMD team</em>
 135 </ul>
 136
 137 <p>The following must pass:</p>
 138 <ul>
 139 <li>make distcheck, 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.
 144 </ul>
 145
 146 <p>
 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.
 150 </p>
 151
 152 <p>
 153 For Windows related changes, the main contact point is Brian
 154 Paul. Jose Fonseca can also help as a fallback contact.
 155 </p>
 156
 157 <p>
 158 For Android related changes, the main contact is Tapani
 159 P&auml;lli. Mauro Rossi is collaborating with android-x86 and may
 160 provide feedback about the build status in that project.
 161 </p>
 162
 163 <p>
 164 For MacOSX related changes, Jeremy Huddleston Sequoia is currently a
 165 good contact point.
 166 </p>
 167
 168 <p>
 169 <strong>Note:</strong> If a patch in the current queue needs any additional
 170 fix(es), then they should be squashed together.
 171 <br>
 172 The commit messages and the <code>cherry picked from</code> tags must be preserved.
 173 </p>
 174
 175 <p>
 176 This should be noted in the <a href="#prerelease">pre-announce</a> email.
 177 </p>
 178
 179 <pre>
 180     git show b10859ec41d09c57663a258f43fe57c12332698e
 181
 182     commit b10859ec41d09c57663a258f43fe57c12332698e
 183     Author: Jonas Pfeil &lt;pfeiljonas@gmx.de&gt;
 184     Date:   Wed Mar 1 18:11:10 2017 +0100
 185
 186         ralloc: Make sure ralloc() allocations match malloc()'s alignment.
 187
 188         The header of ralloc needs to be aligned, because the compiler assumes
 189         ...
 190
 191         (cherry picked from commit cd2b55e536dc806f9358f71db438dd9c246cdb14)
 192
 193         Squashed with commit:
 194
 195         ralloc: don't leave out the alignment factor
 196
 197         Experimentation shows that without alignment factor gcc and clang choose
 198         ...
 199
 200         (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
 201 </pre>
 202
 203 <h2>Regression/functionality testing</h2>
 204
 205 <p>
 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.
 208 </p>
 209
 210 <ul>
 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>
 214 </ul>
 215
 216 <p>
 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.
 218 </p>
 219
 220 <p>
 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
 223 idea too.
 224 </p>
 225
 226 <h1 id="stagingbranch">Staging branch</h1>
 227
 228 <p>
 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:
 231 </p>
 232 <pre>
 233         staging/18.1 - WIP branch for the 18.1 series
 234         staging/18.2 - WIP branch for the 18.2 series
 235 </pre>
 236
 237 <p>
 238 Notes:
 239 </p>
 240 <ul>
 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>
 243 </ul>
 244
 245
 246 <h1 id="branch">Making a branchpoint</h1>
 247
 248 <p>
 249 A branchpoint is made such that new development can continue in parallel to
 250 stabilisation and bugfixing.
 251 </p>
 252
 253 <p>
 254 Note: Before doing a branch ensure that basic build and <code>make check</code>
 255 testing is done and there are little to-no issues.
 256 <br>
 257 Ideally all of those should be tackled already.
 258 </p>
 259
 260 <p>
 261 Check if the version number is going to remain as, alternatively
 262 <code> git mv docs/relnotes/{current,new}.html </code> as appropriate.
 263 </p>
 264
 265 <p>
 266 To setup the branchpoint:
 267 </p>
 268 <pre>
 269         git checkout master # make sure we're in master first
 270         git tag -s X.Y-branchpoint -m "Mesa X.Y branchpoint"
 271         git checkout -b X.Y
 272         git checkout master
 273         $EDITOR VERSION # bump the version number
 274         git commit -as
 275         cp docs/relnotes/{X.Y,X.Y+1}.html # copy/create relnotes template
 276         git commit -as
 277         git push origin X.Y-branchpoint X.Y
 278 </pre>
 279
 280 <p>
 281 Now go to
 282 <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.
 283 </p>
 284
 285 <p>
 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).
 289 </p>
 290
 291 <p>
 292 Proceed to <a href="#release">release</a> -rc1.
 293 </p>
 294
 295
 296 <h1 id="prerelease">Pre-release announcement</h1>
 297
 298 <p>
 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.
 303 <br>
 304 It is followed by a brief period (normally 24 or 48 hours) before the actual
 305 release is made.
 306 </p>
 307
 308 <p>
 309 Be aware to add a note to warn about a final release in a series, if
 310 that is the case.
 311 </p>
 312
 313 <h2>Terminology used</h2>
 314
 315 <ul><li>Nominated</ul>
 316
 317 <p>
 318 Patch that is nominated but yet to to merged in the patch queue/branch.
 319 </p>
 320
 321 <ul><li>Queued</ul>
 322
 323 <p>
 324 Patch is in the queue/branch and will feature in the next release.
 325 Barring reported regressions or objections from developers.
 326 </p>
 327
 328 <ul><li>Rejected</ul>
 329
 330 <p>
 331 Patch does not fit the
 332 <a href="submittingpatches.html#criteria" target="_parent">criteria</a> and
 333 is followed by a brief information.
 334 <br>
 335 The release maintainer is human so if you believe you've spotted a mistake do
 336 let them know.
 337 </p>
 338
 339 <h2>Format/template</h2>
 340 <pre>
 341 Subject: [ANNOUNCE] Mesa X.Y.Z release candidate
 342 To: mesa-announce@...
 343 Cc: mesa-dev@...
 344
 345 Hello list,
 346
 347 The candidate for the Mesa X.Y.Z is now available. Currently we have:
 348  - NUMBER queued
 349  - NUMBER nominated (outstanding)
 350  - and NUMBER rejected patches
 351
 352 [If applicable:
 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.]
 355
 356 BRIEF SUMMARY OF CHANGES
 357
 358 Take a look at section "Mesa stable queue" for more information.
 359
 360
 361 Testing reports/general approval
 362 --------------------------------
 363 Any testing reports (or general approval of the state of the branch) will be
 364 greatly appreciated.
 365
 366 The plan is to have X.Y.Z this DAY (DATE), around or shortly after TIME.
 367
 368 If you have any questions or suggestions - be that about the current patch
 369 queue or otherwise, please go ahead.
 370
 371
 372 Trivial merge conflicts
 373 -----------------------
 374 List of commits where manual intervention was required.
 375 Keep the authors in the CC list.
 376
 377 commit SHA
 378 Author: AUTHOR
 379
 380     COMMIT SUMMARY
 381
 382     CHERRY PICKED FROM
 383
 384
 385 For example:
 386
 387 commit 990f395e007c3204639daa34efc3049f350ee819
 388 Author: Emil Velikov &lt;emil.velikov@collabora.com&gt;
 389
 390     anv: automake: cleanup the generated json file during make clean
 391
 392     (cherry picked from commit 8df581520a823564be0ab5af7dbb7d501b1c9670)
 393
 394
 395 Cheers,
 396 Emil
 397
 398
 399 Mesa stable queue
 400 -----------------
 401
 402 Nominated (NUMBER)
 403 ==================
 404
 405 AUTHOR (NUMBER):
 406       SHA     COMMIT SUMMARY
 407
 408 For example:
 409
 410 Dave Airlie (1):
 411       2de85eb radv: fix texturesamples to handle single sample case
 412
 413
 414 Queued (NUMBER)
 415 ===============
 416
 417 AUTHOR (NUMBER):
 418       COMMIT SUMMARY
 419 [If applicable:
 420 Squashed with
 421       COMMIT SUMMARY]
 422
 423 For example:
 424
 425 Jonas Pfeil (1):
 426       ralloc: Make sure ralloc() allocations match malloc()'s alignment.
 427 Squashed with
 428       ralloc: don't leave out the alignment factor
 429
 430
 431 Rejected (NUMBER)
 432 =================
 433
 434 AUTHOR (NUMBER):
 435       SHA     COMMIT SUMMARY
 436
 437 Reason: ...
 438
 439 For example:
 440
 441 Emil Velikov (1)
 442       a39ad18 configure.ac: honour LLVM_LIBDIR when linking against LLVM
 443
 444 Reason: The patch was reverted shortly after it was merged.
 445 </pre>
 446
 447
 448 <h1 id="release">Making a new release</h1>
 449
 450 <p>
 451 These are the instructions for making a new Mesa release.
 452 </p>
 453
 454 <h3>Get latest source files</h3>
 455
 456 <p>
 457 Ensure the latest code is available - both in your local master and the
 458 relevant branch.
 459 </p>
 460
 461 <h3 id="basictesting">Perform basic testing</h3>
 462
 463 <p>
 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'
 468 </p>
 469
 470 <ul>
 471 <li>make distcheck (you can omit this if you're not using --dist below)
 472 <li>scons (from release tarball)
 473 <li>the produced binaries work
 474 </ul>
 475
 476 <p>
 477 Here is one solution that I've been using.
 478 </p>
 479
 480 <pre>
 481         # Set MAKEFLAGS if you haven't already
 482         git clean -fXd; git clean -nxd
 483         read # quick cross check any outstanding files
 484         export __version=`cat VERSION`
 485         export __mesa_root=../
 486         export __build_root=./foo
 487         chmod 755 -fR $__build_root; rm -rf $__build_root
 488         mkdir -p $__build_root &amp;&amp; cd $__build_root
 489
 490         # For the native builds - such as distcheck, scons, sanity test, you
 491         # may want to specify which LLVM to use:
 492         # export LLVM_CONFIG=/usr/lib/llvm-3.9/bin/llvm-config
 493
 494         # Do a full distcheck
 495         $__mesa_root/autogen.sh &amp;&amp; make distcheck
 496
 497         # Build check the tarballs (scons, linux)
 498         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 499         scons
 500         cd .. &amp;&amp; rm -rf mesa-$__version
 501
 502         # Build check the tarballs (scons, windows/mingw)
 503         # Temporary drop LLVM_CONFIG, unless you have a Windows/mingw one.
 504         # save_LLVM_CONFIG=`echo $LLVM_CONFIG`; unset LLVM_CONFIG
 505         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 506         scons platform=windows toolchain=crossmingw
 507         cd .. &amp;&amp; rm -rf mesa-$__version
 508
 509         # Test the automake binaries
 510         # Restore LLVM_CONFIG, if applicable:
 511         # export LLVM_CONFIG=`echo $save_LLVM_CONFIG`; unset save_LLVM_CONFIG
 512         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 513         ./configure \
 514                 --with-dri-drivers=i965,swrast \
 515                 --with-gallium-drivers=swrast \
 516                 --with-vulkan-drivers=intel \
 517                 --enable-llvm-shared-libs \
 518                 --enable-llvm \
 519                 --enable-glx-tls \
 520                 --enable-gbm \
 521                 --enable-egl \
 522                 --with-platforms=x11,drm,wayland,surfaceless
 523         make &amp;&amp; DESTDIR=`pwd`/test make install
 524
 525         # Drop LLVM_CONFIG, if applicable:
 526         # unset LLVM_CONFIG
 527
 528         __glxinfo_cmd='glxinfo 2&gt;&amp;1 | egrep -o "Mesa.*|Gallium.*|.*dri\.so"'
 529         __glxgears_cmd='glxgears 2&gt;&amp;1 | grep -v "configuration file"'
 530         __es2info_cmd='es2_info 2&gt;&amp;1 | egrep "GL_VERSION|GL_RENDERER|.*dri\.so"'
 531         __es2gears_cmd='es2gears_x11 2&gt;&amp;1 | grep -v "configuration file"'
 532         test "x$LD_LIBRARY_PATH" != 'x' &amp;&amp; __old_ld="$LD_LIBRARY_PATH"
 533         export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/:"${__old_ld}"
 534         export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
 535         export LIBGL_DEBUG=verbose
 536         eval $__glxinfo_cmd
 537         eval $__glxgears_cmd
 538         eval $__es2info_cmd
 539         eval $__es2gears_cmd
 540         export LIBGL_ALWAYS_SOFTWARE=true
 541         eval $__glxinfo_cmd
 542         eval $__glxgears_cmd
 543         eval $__es2info_cmd
 544         eval $__es2gears_cmd
 545         export LIBGL_ALWAYS_SOFTWARE=true
 546         export GALLIUM_DRIVER=softpipe
 547         eval $__glxinfo_cmd
 548         eval $__glxgears_cmd
 549         eval $__es2info_cmd
 550         eval $__es2gears_cmd
 551         # Smoke test DOTA2
 552         unset LD_LIBRARY_PATH
 553         test "x$__old_ld" != 'x' &amp;&amp; export LD_LIBRARY_PATH="$__old_ld" &amp;&amp; unset __old_ld
 554         unset LIBGL_DRIVERS_PATH
 555         unset LIBGL_DEBUG
 556         unset LIBGL_ALWAYS_SOFTWARE
 557         unset GALLIUM_DRIVER
 558         export VK_ICD_FILENAMES=`pwd`/src/intel/vulkan/dev_icd.json
 559         steam steam://rungameid/570  -vconsole -vulkan
 560         unset VK_ICD_FILENAMES
 561 </pre>
 562
 563 <h3>Update version in file VERSION</h3>
 564
 565 <p>
 566 Increment the version contained in the file VERSION at Mesa's top-level, then
 567 commit this change.
 568 </p>
 569
 570 <h3>Create release notes for the new release</h3>
 571
 572 <p>
 573 Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
 574 release notes). Note that the sha256sums section of the release notes should
 575 be empty (TBD) at this point.
 576 </p>
 577
 578 <p>
 579 Two scripts are available to help generate portions of the release notes:
 580 </p>
 581
 582 <pre>
 583         ./bin/bugzilla_mesa.sh
 584         ./bin/shortlog_mesa.sh
 585 </pre>
 586
 587 <p>
 588 The first script identifies commits that reference bugzilla bugs and obtains
 589 the descriptions of those bugs from bugzilla. The second script generates a
 590 log of all commits. In both cases, HTML-formatted lists are printed to stdout
 591 to be included in the release notes.
 592 </p>
 593
 594 <p>
 595 Commit these changes and push the branch.
 596 </p>
 597
 598 <pre>
 599         git push origin HEAD
 600 </pre>
 601
 602
 603 <h3>Use the release.sh script from xorg <a href="https://cgit.freedesktop.org/xorg/util/modular/">util-modular</a></h3>
 604
 605 <p>
 606 Start the release process.
 607 </p>
 608
 609 <pre>
 610         # For the dist/distcheck, you may want to specify which LLVM to use:
 611         # export LLVM_CONFIG=/usr/lib/llvm-3.9/bin/llvm-config
 612         ../relative/path/to/release.sh . # append --dist if you've already done distcheck above
 613 </pre>
 614
 615 <p>
 616 Pay close attention to the prompts as you might be required to enter your GPG
 617 and SSH passphrase(s) to sign and upload the files, respectively.
 618 </p>
 619
 620 <h3>Add the sha256sums to the release notes</h3>
 621
 622 <p>
 623 Edit docs/relnotes/X.Y.Z.html to add the sha256sums as available in the mesa-X.Y.Z.announce template. Commit this change.
 624 </p>
 625
 626 <h3>Back on mesa master, add the new release notes into the tree</h3>
 627
 628 <p>
 629 Something like the following steps will do the trick:
 630 </p>
 631
 632 <pre>
 633         git cherry-pick -x X.Y~1
 634         git cherry-pick -x X.Y
 635 </pre>
 636
 637 <p>
 638 Also, edit docs/relnotes.html to add a link to the new release notes,
 639 edit docs/index.html to add a news entry and a note in case of the
 640 last release in a series, and remove the version from
 641 docs/release-calendar.html. Then commit and push:
 642 </p>
 643
 644 <pre>
 645         git commit -as -m "docs: update calendar, add news item and link release notes for X.Y.Z"
 646         git push origin master X.Y
 647 </pre>
 648
 649
 650 <h1 id="announce">Announce the release</h1>
 651
 652 <p>
 653 Use the generated template during the releasing process.
 654 </p>
 655
 656 <p>
 657 Again, pay attention to add a note to warn about a final release in a
 658 series, if that is the case.
 659 </p>
 660
 661
 662 <h1 id="website">Update the mesa3d.org website</h1>
 663
 664 <p>
 665 As the hosting was moved to freedesktop, git hooks are deployed to update the
 666 website. Manually check that it is updated 5-10 minutes after the final <code>git push</code>
 667 </p>
 668
 669
 670 <h1 id="bugzilla">Update Bugzilla</h1>
 671
 672 <p>
 673 Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
 674 document.
 675 <br>
 676 If there's outstanding action, close the bug referencing the commit ID which
 677 addresses the bug and mention the Mesa version that has the fix.
 678 </p>
 679
 680 <p>
 681 Note: the above is not applicable to all the reports, so use common sense.
 682 </p>
 683
 684
 685 </div>
 686 </body>
 687 </html>