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

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