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

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