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 <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>
  34 This document uses the convention X.Y.Z for the release number with X.Y being
  35 the stable branch name.
  36 <br>
  37 Mesa provides feature and bugfix releases. Former use zero as patch version (Z),
  38 while the latter have a non-zero one.
  39 </p>
  40
  41 <p>
  42 For 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>
  54 Releases should happen on Fridays. Delays can occur although those should be keep
  55 to a minimum.
  56 </p>
  57
  58 <h2>Feature releases</h2>
  59 <ul>
  60 <li>Available approximately every three months.
  61 <li>Initial timeplan available 2-4 weeks before the planned branchpoint (rc1)
  62 on the mesa-announce@ mailing list.
  63 <li>A <a href="#prerelease">pre-release</a> announcement should be available
  64 approximately 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
  72 approximately 48 hours before the actual release.
  73 </ul>
  74
  75 <p>
  76 Note: There is one or two releases overlap when changing branches. For example:
  77 <br>
  78 The final release from the 12.0 series Mesa 12.0.5 will be out around the same
  79 time (or shortly after) 13.0.1 is out.
  80 </p>
  81
  82 <h1 id="pickntest">Cherry-picking and testing</h1>
  83
  84 <p>
  85 Commits nominated for the active branch are picked as based on the
  86 <a href="submittingpatches.html#criteria" target="_parent">criteria</a> as
  87 described in the same section.
  88
  89 <p>
  90 Maintainer is responsible for testing in various possible permutations of
  91 the 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>
  99 As an exception, patches can be applied up-to the last ~1h before the actual
 100 release. This is made <strong>only</strong> with explicit permission/request,
 101 and the patch <strong>must</strong> be very well contained. Thus it cannot
 102 affect more than one driver/subsystem.
 103 </p>
 104 <p>
 105 Currently 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
 112 performed where possible.
 113 </ul>
 114 <p>
 115 Achieved by combination of local ad-hoc scripts and AppVeyor plus Travis-CI,
 116 the latter as part of their Github integration.
 117 </p>
 118
 119 <h2>Regression/functionality testing</h2>
 120
 121 <p>
 122 Less often (once or twice), shortly before the pre-release announcement.
 123 Ensure 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
 128 and llvmpipe drivers</em>
 129 </ul>
 130 <p>
 131 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.
 132 </p>
 133
 134
 135 <h1 id="branch">Making a branchpoint</h1>
 136
 137 <p>
 138 A branchpoint is made such that new development can continue in parallel to
 139 stabilisation and bugfixing.
 140 </p>
 141
 142 <p>
 143 Note: Before doing a branch ensure that basic build and <code>make check</code>
 144 testing is done and there are little to-no issues.
 145 <br>
 146 Ideally all of those should be tackled already.
 147 </p>
 148
 149 <p>
 150 Check 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>
 155 To 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
 161         git checkout master
 162         $EDITOR VERSION # bump the version number
 163         git commit -as
 164         cp docs/relnotes/{X.Y,X.Y+1}.html # copy/create relnotes template
 165         git commit -as
 166         git push origin X.Y-branchpoint X.Y
 167 </pre>
 168
 169 <p>
 170 Now 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>
 174 Check that there are no distribution breaking changes and revert them if needed.
 175 For example: files being overwritten on install, etc. Happens extremely rarely -
 176 we had only one case so far (see commit 2ced8eb136528914e1bf4e000dea06a9d53c7e04).
 177 </p>
 178 <p>
 179 Proceed to <a href="#release">release</a> -rc1.
 180 </p>
 181
 182 <h1 id="prerelease">Pre-release announcement</h1>
 183
 184 <p>
 185 It comes shortly after outstanding patches in the respective branch are pushed.
 186 Developers can check, in brief, what's the status of their patches. They,
 187 alongside very early testers, are strongly encouraged to test the branch and
 188 report any regressions.
 189 <br>
 190 It is followed by a brief period (normally 24 or 48 hours) before the actual
 191 release is made.
 192 </p>
 193
 194 <h2>Terminology used</h2>
 195 <ul><li>Nominated</ul>
 196 <p>
 197 Patch that is nominated but yet to to merged in the patch queue/branch.
 198 </p>
 199
 200 <ul><li>Queued</ul>
 201 <p>
 202 Patch is in the queue/branch and will feature in the next release.
 203 Barring reported regressions or objections from developers.
 204 </p>
 205
 206 <ul><li>Rejected</ul>
 207 <p>
 208 Patch does not fit the
 209 <a href="submittingpatches.html#criteria" target="_parent">criteria</a> and
 210 is followed by a brief information.
 211 <br>
 212 The release maintainer is human so if you believe you've spotted a mistake do
 213 let them know.
 214 </p>
 215
 216 <h2>Format/template</h2>
 217 <pre>
 218 Subject: [ANNOUNCE] Mesa X.Y.Z release candidate
 219 To: mesa-announce@...
 220 Cc: mesa-dev@...
 221
 222 Hello list,
 223
 224 The 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
 229 BRIEF SUMMARY OF CHANGES
 230
 231 Take a look at section "Mesa stable queue" for more information.
 232
 233
 234 Testing reports/general approval
 235 --------------------------------
 236 Any testing reports (or general approval of the state of the branch) will be
 237 greatly appreciated.
 238
 239 The plan is to have X.Y.Z this DAY (DATE), around or shortly after TIME.
 240
 241 If you have any questions or suggestions - be that about the current patch
 242 queue or otherwise, please go ahead.
 243
 244
 245 Trivial merge conflicts
 246 -----------------------
 247 List of commits where manual intervention was required.
 248 Keep the authors in the CC list.
 249
 250 commit SHA
 251 Author: AUTHOR
 252
 253     COMMIT SUMMARY
 254
 255     CHERRY PICKED FROM
 256
 257
 258 For example:
 259
 260 commit 990f395e007c3204639daa34efc3049f350ee819
 261 Author: 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
 268 Cheers,
 269 Emil
 270
 271
 272 Mesa stable queue
 273 -----------------
 274
 275 Nominated (NUMBER)
 276 ==================
 277
 278 AUTHOR (NUMBER):
 279       SHA     COMMIT SUMMARY
 280
 281 For example:
 282
 283 Dave Airlie (1):
 284       2de85eb radv: fix texturesamples to handle single sample case
 285
 286
 287 Queued (NUMBER)
 288 ===============
 289
 290 AUTHOR (NUMBER):
 291       COMMIT SUMMARY
 292
 293
 294 Rejected (NUMBER)
 295 =================
 296
 297 Rejected (11)
 298 =============
 299
 300 AUTHOR (NUMBER):
 301       SHA     COMMIT SUMMARY
 302
 303 Reason: ...
 304 </pre>
 305
 306 <h1 id="release">Making a new release</h1>
 307
 308 <p>
 309 These are the instructions for making a new Mesa release.
 310 </p>
 311
 312 <h3>Get latest source files</h3>
 313 <p>
 314 Ensure the latest code is available - both in your local master and the
 315 relevant branch.
 316 </p>
 317
 318 <h3>Perform basic testing</h3>
 319 <p>
 320 Most 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
 324 So 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>
 332 Here 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
 338         export __version=`cat VERSION`
 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
 344         $__mesa_root/autogen.sh --enable-llvm-shared-libs &amp;&amp; make -j2 distcheck
 345
 346         # Build check the tarballs (scons, linux)
 347         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 348         scons
 349         cd .. &amp;&amp; rm -rf mesa-$__version
 350
 351         # Build check the tarballs (scons, windows/mingw)
 352         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 353         scons platform=windows toolchain=crossmingw
 354         cd .. &amp;&amp; rm -rf mesa-$__version
 355
 356         # Test the automake binaries
 357         tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
 358         ./configure \
 359                 --with-dri-drivers=i965,swrast \
 360                 --with-gallium-drivers=swrast \
 361                 --with-vulkan-drivers=intel \
 362                 --enable-llvm-shared-libs \
 363                 --enable-llvm \
 364                 --enable-glx-tls \
 365                 --enable-gbm \
 366                 --enable-egl \
 367                 --with-egl-platforms=x11,drm,wayland
 368         make -j2 &amp;&amp; DESTDIR=`pwd`/test make -j6 install
 369         __glxinfo_cmd='glxinfo 2>&amp;1 | egrep -o "Mesa.*|Gallium.*|.*dri\.so"'
 370         __glxgears_cmd='glxgears 2>&amp;1 | grep -v "configuration file"'
 371         __es2info_cmd='es2_info 2>&amp;1 | egrep "GL_VERSION|GL_RENDERER|.*dri\.so"'
 372         __es2gears_cmd='es2gears_x11 2>&amp;1 | grep -v "configuration file"'
 373         export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/
 374         export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
 375         export LIBGL_DEBUG=verbose
 376         eval $__glxinfo_cmd
 377         eval $__glxgears_cmd
 378         eval $__es2info_cmd
 379         eval $__es2gears_cmd
 380         export LIBGL_ALWAYS_SOFTWARE=1
 381         eval $__glxinfo_cmd
 382         eval $__glxgears_cmd
 383         eval $__es2info_cmd
 384         eval $__es2gears_cmd
 385         export LIBGL_ALWAYS_SOFTWARE=1
 386         export GALLIUM_DRIVER=softpipe
 387         eval $__glxinfo_cmd
 388         eval $__glxgears_cmd
 389         eval $__es2info_cmd
 390         eval $__es2gears_cmd
 391         # Smoke test DOTA2
 392         unset LD_LIBRARY_PATH
 393         unset LIBGL_DRIVERS_PATH
 394         unset LIBGL_DEBUG
 395         unset LIBGL_ALWAYS_SOFTWARE
 396         export VK_ICD_FILENAMES=`pwd`/src/intel/vulkan/dev_icd.json
 397         steam steam://rungameid/570  -vconsole -vulkan
 398 </pre>
 399
 400 <h3>Update version in file VERSION</h3>
 401
 402 <p>
 403 Increment the version contained in the file VERSION at Mesa's top-level, then
 404 commit this change.
 405 </p>
 406
 407 <h3>Create release notes for the new release</h3>
 408
 409 <p>
 410 Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
 411 release notes). Note that the sha256sums section of the release notes should
 412 be empty (TBD) at this point.
 413 </p>
 414
 415 <p>
 416 Two scripts are available to help generate portions of the release notes:
 417
 418 <pre>
 419         ./bin/bugzilla_mesa.sh
 420         ./bin/shortlog_mesa.sh
 421 </pre>
 422
 423 <p>
 424 The first script identifies commits that reference bugzilla bugs and obtains
 425 the descriptions of those bugs from bugzilla. The second script generates a
 426 log of all commits. In both cases, HTML-formatted lists are printed to stdout
 427 to be included in the release notes.
 428 </p>
 429
 430 <p>
 431 Commit these changes and push the branch.
 432 </p>
 433 <pre>
 434         git push origin HEAD
 435 </pre>
 436
 437
 438 <h3>Use the release.sh script from xorg <a href="https://cgit.freedesktop.org/xorg/util/modular/">util-modular</a></h3>
 439
 440 <p>
 441 Start the release process.
 442 </p>
 443 <pre>
 444         ../relative/path/to/release.sh . # append --dist if you've already done distcheck above
 445 </pre>
 446
 447 <p>
 448 Pay close attention to the prompts as you might be required to enter your GPG
 449 and SSH passphrase(s) to sign and upload the files, respectively.
 450 </p>
 451
 452 <h3>Add the sha256sums to the release notes</h3>
 453
 454 <p>
 455 Edit docs/relnotes/X.Y.Z.html to add the sha256sums as available in the mesa-X.Y.Z.announce template. Commit this change.
 456 </p>
 457
 458 <h3>Back on mesa master, add the new release notes into the tree</h3>
 459
 460 <p>
 461 Something like the following steps will do the trick:
 462 </p>
 463
 464 <pre>
 465         git cherry-pick -x X.Y~1
 466         git cherry-pick -x X.Y
 467 </pre>
 468
 469 <p>
 470 Also, edit docs/relnotes.html to add a link to the new release notes, and edit
 471 docs/index.html to add a news entry. Then commit and push:
 472 </p>
 473
 474 <pre>
 475         git commit -as -m "docs: add news item and link release notes for X.Y.Z"
 476         git push origin master X.Y
 477 </pre>
 478
 479
 480 <h1 id="announce">Announce the release</h1>
 481 <p>
 482 Use the generated template during the releasing process.
 483 </p>
 484
 485
 486 <h1 id="website">Update the mesa3d.org website</h1>
 487
 488 <p>
 489 As the hosting was moved to freedesktop, git hooks are deployed to update the
 490 website. Manually check that it is updated 5-10 minutes after the final <code>git push</code>
 491 </p>
 492
 493 <h1 id="bugzilla">Update Bugzilla</h1>
 494
 495 <p>
 496 Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
 497 document.
 498 <br>
 499 If there's outstanding action, close the bug referencing the commit ID which
 500 addresses the bug and mention the Mesa version that has the fix.
 501 </p>
 502
 503 <p>
 504 Note: the above is not applicable to all the reports, so use common sense.
 505 </p>
 506
 507
 508 </div>
 509 </body>
 510 </html>