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

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