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

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