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="#branch">Making a branchpoint</a>
  25 <li><a href="#prerelease">Pre-release announcement</a>
  26 <li><a href="#release">Making a new release</a>
  27 <li><a href="#calendar">Update the calendar</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 Fridays. Delays can occur although those should be keep
  59 to a minimum.
  60 <br>
  61 See our <a href="release-calendar.html" target="_parent">calendar</a> for the
  62 date and other details for individual releases.
  63 </p>
  64
  65 <h2>Feature releases</h2>
  66 <ul>
  67 <li>Available approximately every three months.
  68 <li>Initial timeplan available 2-4 weeks before the planned branchpoint (rc1)
  69 on the mesa-announce@ mailing list.
  70 <li>A <a href="#prerelease">pre-release</a> announcement should be available
  71 approximately 24 hours before the final (non-rc) release.
  72 </ul>
  73
  74 <h2>Stable releases</h2>
  75 <ul>
  76 <li>Normally available once every two weeks.
  77 <li>Only the latest branch has releases. See note below.
  78 <li>A <a href="#prerelease">pre-release</a> announcement should be available
  79 approximately 48 hours before the actual release.
  80 </ul>
  81
  82 <p>
  83 Note: There is one or two releases overlap when changing branches. For example:
  84 <br>
  85 The final release from the 12.0 series Mesa 12.0.5 will be out around the same
  86 time (or shortly after) 13.0.1 is out.
  87 </p>
  88
  89
  90 <h1 id="pickntest">Cherry-picking and testing</h1>
  91
  92 <p>
  93 Commits nominated for the active branch are picked as based on the
  94 <a href="submittingpatches.html#criteria" target="_parent">criteria</a> as
  95 described in the same section.
  96 </p>
  97
  98 <p>
  99 Nomination happens in the mesa-stable@ mailing list. However,
 100 maintainer is resposible of checking for forgotten candidates in the
 101 master branch. This is achieved by a combination of ad-hoc scripts and
 102 a casual search for terms such as regression, fix, broken and similar.
 103 </p>
 104
 105 <p>
 106 Maintainer is also responsible for testing in various possible permutations of
 107 the autoconf and scons build.
 108 </p>
 109
 110 <h2>Cherry-picking and build/check testing</h2>
 111
 112 <p>Done continuously up-to the <a href="#prerelease">pre-release</a> announcement.</p>
 113
 114 <p>
 115 As an exception, patches can be applied up-to the last ~1h before the actual
 116 release. This is made <strong>only</strong> with explicit permission/request,
 117 and the patch <strong>must</strong> be very well contained. Thus it cannot
 118 affect more than one driver/subsystem.
 119 </p>
 120
 121 <p>
 122 Currently Ilia Mirkin and AMD devs have requested "permanent" exception.
 123 </p>
 124
 125 <ul>
 126 <li>make distcheck, scons and scons check must pass
 127 <li>Testing with different version of system components - LLVM and others is also
 128 performed where possible.
 129 <li>As a general rule, testing with various combinations of configure
 130 switches, depending on the specific patchset.
 131 </ul>
 132
 133 <p>
 134 Achieved by combination of local ad-hoc scripts, mingw-w64 cross
 135 compilation and AppVeyor plus Travis-CI, the latter as part of their
 136 Github integration.
 137 </p>
 138
 139 <p>
 140 For Windows related changes, the main contact point is Brian
 141 Paul. Jose Fonseca can also help as a fallback contact.
 142 </p>
 143
 144 <p>
 145 For Android related changes, the main contact is Tapani
 146 P&auml;lli. Mauro Rossi is collaborating with android-x86 and may
 147 provide feedback about the build status in that project.
 148 </p>
 149
 150 <p>
 151 For MacOSX related changes, Jeremy Huddleston Sequoia is currently a
 152 good contact point.
 153 </p>
 154
 155 <p>
 156 <strong>Note:</strong> If a patch in the current queue needs any additional
 157 fix(es), then they should be squashed together.
 158 <br>
 159 The commit messages and the <code>cherry picked from</code> tags must be preserved.
 160 </p>
 161
 162 <p>
 163 This should be noted in the <a href="#prerelease">pre-announce</a> email.
 164 </p>
 165
 166 <pre>
 167     git show b10859ec41d09c57663a258f43fe57c12332698e
 168
 169     commit b10859ec41d09c57663a258f43fe57c12332698e
 170     Author: Jonas Pfeil &lt;pfeiljonas@gmx.de&gt;
 171     Date:   Wed Mar 1 18:11:10 2017 +0100
 172
 173         ralloc: Make sure ralloc() allocations match malloc()'s alignment.
 174
 175         The header of ralloc needs to be aligned, because the compiler assumes
 176         ...
 177
 178         (cherry picked from commit cd2b55e536dc806f9358f71db438dd9c246cdb14)
 179
 180         Squashed with commit:
 181
 182         ralloc: don't leave out the alignment factor
 183
 184         Experimentation shows that without alignment factor gcc and clang choose
 185         ...
 186
 187         (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
 188 </pre>
 189
 190 <h2>Regression/functionality testing</h2>
 191
 192 <p>
 193 Less often (once or twice), shortly before the pre-release announcement.
 194 Ensure that testing is redone if Intel devs have requested an exception, as per above.
 195 </p>
 196
 197 <ul>
 198 <li><em>no regressions should be observed for Piglit/dEQP/CTS/Vulkan on Intel platforms</em>
 199 <li><em>no regressions should be observed for Piglit using the swrast, softpipe
 200 and llvmpipe drivers</em>
 201 </ul>
 202
 203 <p>
 204 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.
 205 </p>
 206
 207 <p>
 208 Installing the built driver from the pre-announced RC branch in the
 209 system and making some every day's use until the release may be a good
 210 idea too.
 211 </p>
 212
 213
 214 <h1 id="branch">Making a branchpoint</h1>
 215
 216 <p>
 217 A branchpoint is made such that new development can continue in parallel to
 218 stabilisation and bugfixing.
 219 </p>
 220
 221 <p>
 222 Note: Before doing a branch ensure that basic build and <code>make check</code>
 223 testing is done and there are little to-no issues.
 224 <br>
 225 Ideally all of those should be tackled already.
 226 </p>
 227
 228 <p>
 229 Check if the version number is going to remain as, alternatively
 230 <code> git mv docs/relnotes/{current,new}.html </code> as appropriate.
 231 </p>
 232
 233 <p>
 234 To setup the branchpoint:
 235 </p>
 236 <pre>
 237         git checkout master # make sure we're in master first
 238         git tag -s X.Y-branchpoint -m "Mesa X.Y branchpoint"
 239         git checkout -b X.Y
 240         git checkout master
 241         $EDITOR VERSION # bump the version number
 242         git commit -as
 243         cp docs/relnotes/{X.Y,X.Y+1}.html # copy/create relnotes template
 244         git commit -as
 245         git push origin X.Y-branchpoint X.Y
 246 </pre>
 247
 248 <p>
 249 Now go to
 250 <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.
 251 </p>
 252
 253 <p>
 254 Check that there are no distribution breaking changes and revert them if needed.
 255 For example: files being overwritten on install, etc. Happens extremely rarely -
 256 we had only one case so far (see commit 2ced8eb136528914e1bf4e000dea06a9d53c7e04).
 257 </p>
 258
 259 <p>
 260 Proceed to <a href="#release">release</a> -rc1.
 261 </p>
 262
 263
 264 <h1 id="prerelease">Pre-release announcement</h1>
 265
 266 <p>
 267 It comes shortly after outstanding patches in the respective branch are pushed.
 268 Developers can check, in brief, what's the status of their patches. They,
 269 alongside very early testers, are strongly encouraged to test the branch and
 270 report any regressions.
 271 <br>
 272 It is followed by a brief period (normally 24 or 48 hours) before the actual
 273 release is made.
 274 </p>
 275
 276 <h2>Terminology used</h2>
 277
 278 <ul><li>Nominated</ul>
 279
 280 <p>
 281 Patch that is nominated but yet to to merged in the patch queue/branch.
 282 </p>
 283
 284 <ul><li>Queued</ul>
 285
 286 <p>
 287 Patch is in the queue/branch and will feature in the next release.
 288 Barring reported regressions or objections from developers.
 289 </p>
 290
 291 <ul><li>Rejected</ul>
 292
 293 <p>
 294 Patch does not fit the
 295 <a href="submittingpatches.html#criteria" target="_parent">criteria</a> and
 296 is followed by a brief information.
 297 <br>
 298 The release maintainer is human so if you believe you've spotted a mistake do
 299 let them know.
 300 </p>
 301
 302 <h2>Format/template</h2>
 303 <pre>
 304 Subject: [ANNOUNCE] Mesa X.Y.Z release candidate
 305 To: mesa-announce@...
 306 Cc: mesa-dev@...
 307
 308 Hello list,
 309
 310 The candidate for the Mesa X.Y.Z is now available. Currently we have:
 311  - NUMBER queued
 312  - NUMBER nominated (outstanding)
 313  - and NUMBER rejected patches
 314
 315 BRIEF SUMMARY OF CHANGES
 316
 317 Take a look at section "Mesa stable queue" for more information.
 318
 319
 320 Testing reports/general approval
 321 --------------------------------
 322 Any testing reports (or general approval of the state of the branch) will be
 323 greatly appreciated.
 324
 325 The plan is to have X.Y.Z this DAY (DATE), around or shortly after TIME.
 326
 327 If you have any questions or suggestions - be that about the current patch
 328 queue or otherwise, please go ahead.
 329
 330
 331 Trivial merge conflicts
 332 -----------------------
 333 List of commits where manual intervention was required.
 334 Keep the authors in the CC list.
 335
 336 commit SHA
 337 Author: AUTHOR
 338
 339     COMMIT SUMMARY
 340
 341     CHERRY PICKED FROM
 342
 343
 344 For example:
 345
 346 commit 990f395e007c3204639daa34efc3049f350ee819
 347 Author: Emil Velikov &lt;emil.velikov@collabora.com&gt;
 348
 349     anv: automake: cleanup the generated json file during make clean
 350
 351     (cherry picked from commit 8df581520a823564be0ab5af7dbb7d501b1c9670)
 352
 353
 354 Cheers,
 355 Emil
 356
 357
 358 Mesa stable queue
 359 -----------------
 360
 361 Nominated (NUMBER)
 362 ==================
 363
 364 AUTHOR (NUMBER):
 365       SHA     COMMIT SUMMARY
 366
 367 For example:
 368
 369 Dave Airlie (1):
 370       2de85eb radv: fix texturesamples to handle single sample case
 371
 372
 373 Queued (NUMBER)
 374 ===============
 375
 376 AUTHOR (NUMBER):
 377       COMMIT SUMMARY
 378
 379 For example:
 380
 381 Jonas Pfeil (1):
 382       ralloc: Make sure ralloc() allocations match malloc()'s alignment.
 383 Squashed with
 384       ralloc: don't leave out the alignment factor
 385
 386 Rejected (NUMBER)
 387 =================
 388
 389 Rejected (11)
 390 =============
 391
 392 AUTHOR (NUMBER):
 393       SHA     COMMIT SUMMARY
 394
 395 Reason: ...
 396 </pre>
 397
 398
 399 <h1 id="release">Making a new release</h1>
 400
 401 <p>
 402 These are the instructions for making a new Mesa release.
 403 </p>
 404
 405 <h3>Get latest source files</h3>
 406
 407 <p>
 408 Ensure the latest code is available - both in your local master and the
 409 relevant branch.
 410 </p>
 411
 412 <h3>Perform basic testing</h3>
 413
 414 <p>
 415 Most of the testing should already be done during the
 416 <a href="#pickntest">cherry-pick</a> and
 417 <a href="#prerelease">pre-announce</a> stages.
 418 So we do a quick 'touch test'
 419 </p>
 420
 421 <ul>
 422 <li>make distcheck (you can omit this if you're not using --dist below)
 423 <li>scons (from release tarball)
 424 <li>the produced binaries work
 425 </ul>
 426
 427 <p>
 428 Here is one solution that I've been using.
 429 </p>
 430
 431 <pre>
 432         git clean -fXd; git clean -nxd
 433         read # quick cross check any outstanding files
 434         export __version=`cat VERSION`
 435         export __mesa_root=../
 436         export __build_root=./foo
 437         chmod 755 -fR $__build_root; rm -rf $__build_root
 438         mkdir -p $__build_root &amp;&amp; cd $__build_root
 439
 440         $__mesa_root/autogen.sh &amp;&amp; make -j2 distcheck
 441
 442         # Build check the tarballs (scons, linux)
 443         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 444         scons
 445         cd .. &amp;&amp; rm -rf mesa-$__version
 446
 447         # Build check the tarballs (scons, windows/mingw)
 448         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 449         scons platform=windows toolchain=crossmingw
 450         cd .. &amp;&amp; rm -rf mesa-$__version
 451
 452         # Test the automake binaries
 453         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 454         ./configure \
 455                 --with-dri-drivers=i965,swrast \
 456                 --with-gallium-drivers=swrast \
 457                 --with-vulkan-drivers=intel \
 458                 --enable-llvm-shared-libs \
 459                 --enable-llvm \
 460                 --enable-glx-tls \
 461                 --enable-gbm \
 462                 --enable-egl \
 463                 --with-platforms=x11,drm,wayland,surfaceless
 464         make -j2 &amp;&amp; DESTDIR=`pwd`/test make -j6 install
 465         __glxinfo_cmd='glxinfo 2>&amp;1 | egrep -o "Mesa.*|Gallium.*|.*dri\.so"'
 466         __glxgears_cmd='glxgears 2>&amp;1 | grep -v "configuration file"'
 467         __es2info_cmd='es2_info 2>&amp;1 | egrep "GL_VERSION|GL_RENDERER|.*dri\.so"'
 468         __es2gears_cmd='es2gears_x11 2>&amp;1 | grep -v "configuration file"'
 469         export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/
 470         export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
 471         export LIBGL_DEBUG=verbose
 472         eval $__glxinfo_cmd
 473         eval $__glxgears_cmd
 474         eval $__es2info_cmd
 475         eval $__es2gears_cmd
 476         export LIBGL_ALWAYS_SOFTWARE=1
 477         eval $__glxinfo_cmd
 478         eval $__glxgears_cmd
 479         eval $__es2info_cmd
 480         eval $__es2gears_cmd
 481         export LIBGL_ALWAYS_SOFTWARE=1
 482         export GALLIUM_DRIVER=softpipe
 483         eval $__glxinfo_cmd
 484         eval $__glxgears_cmd
 485         eval $__es2info_cmd
 486         eval $__es2gears_cmd
 487         # Smoke test DOTA2
 488         unset LD_LIBRARY_PATH
 489         unset LIBGL_DRIVERS_PATH
 490         unset LIBGL_DEBUG
 491         unset LIBGL_ALWAYS_SOFTWARE
 492         export VK_ICD_FILENAMES=`pwd`/src/intel/vulkan/dev_icd.json
 493         steam steam://rungameid/570  -vconsole -vulkan
 494 </pre>
 495
 496 <h3>Update version in file VERSION</h3>
 497
 498 <p>
 499 Increment the version contained in the file VERSION at Mesa's top-level, then
 500 commit this change.
 501 </p>
 502
 503 <h3>Create release notes for the new release</h3>
 504
 505 <p>
 506 Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
 507 release notes). Note that the sha256sums section of the release notes should
 508 be empty (TBD) at this point.
 509 </p>
 510
 511 <p>
 512 Two scripts are available to help generate portions of the release notes:
 513 </p>
 514
 515 <pre>
 516         ./bin/bugzilla_mesa.sh
 517         ./bin/shortlog_mesa.sh
 518 </pre>
 519
 520 <p>
 521 The first script identifies commits that reference bugzilla bugs and obtains
 522 the descriptions of those bugs from bugzilla. The second script generates a
 523 log of all commits. In both cases, HTML-formatted lists are printed to stdout
 524 to be included in the release notes.
 525 </p>
 526
 527 <p>
 528 Commit these changes and push the branch.
 529 </p>
 530
 531 <pre>
 532         git push origin HEAD
 533 </pre>
 534
 535
 536 <h3>Use the release.sh script from xorg <a href="https://cgit.freedesktop.org/xorg/util/modular/">util-modular</a></h3>
 537
 538 <p>
 539 Start the release process.
 540 </p>
 541
 542 <pre>
 543         ../relative/path/to/release.sh . # append --dist if you've already done distcheck above
 544 </pre>
 545
 546 <p>
 547 Pay close attention to the prompts as you might be required to enter your GPG
 548 and SSH passphrase(s) to sign and upload the files, respectively.
 549 </p>
 550
 551 <h3>Add the sha256sums to the release notes</h3>
 552
 553 <p>
 554 Edit docs/relnotes/X.Y.Z.html to add the sha256sums as available in the mesa-X.Y.Z.announce template. Commit this change.
 555 </p>
 556
 557 <h3>Back on mesa master, add the new release notes into the tree</h3>
 558
 559 <p>
 560 Something like the following steps will do the trick:
 561 </p>
 562
 563 <pre>
 564         git cherry-pick -x X.Y~1
 565         git cherry-pick -x X.Y
 566 </pre>
 567
 568 <p>
 569 Also, edit docs/relnotes.html to add a link to the new release notes, and edit
 570 docs/index.html to add a news entry. Then commit and push:
 571 </p>
 572
 573 <pre>
 574         git commit -as -m "docs: add news item and link release notes for X.Y.Z"
 575         git push origin master X.Y
 576 </pre>
 577
 578
 579 <h1 id="calendar">Update the calendar</h1>
 580
 581 <p>
 582 Remove the version from the <a href="release-calendar.html" target="_parent">calendar</a>.
 583 </p>
 584
 585
 586 <h1 id="announce">Announce the release</h1>
 587
 588 <p>
 589 Use the generated template during the releasing process.
 590 </p>
 591
 592
 593 <h1 id="website">Update the mesa3d.org website</h1>
 594
 595 <p>
 596 As the hosting was moved to freedesktop, git hooks are deployed to update the
 597 website. Manually check that it is updated 5-10 minutes after the final <code>git push</code>
 598 </p>
 599
 600
 601 <h1 id="bugzilla">Update Bugzilla</h1>
 602
 603 <p>
 604 Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
 605 document.
 606 <br>
 607 If there's outstanding action, close the bug referencing the commit ID which
 608 addresses the bug and mention the Mesa version that has the fix.
 609 </p>
 610
 611 <p>
 612 Note: the above is not applicable to all the reports, so use common sense.
 613 </p>
 614
 615
 616 </div>
 617 </body>
 618 </html>