Blame - docs/releasing.html - platform/external/mesa3d

blob: 15df022e5f69980ac6fff22c4eda8f83f32b201c [file] [log] [blame]

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