TDM Release Mechanics - Revision history

Nbohr1more: /* Changelog and Announcement */

2024-06-11T02:09:15Z

Changelog and Announcement

← Older revision		Revision as of 02:09, 11 June 2024
Line 247:		Line 247:

	Use SVN log over both repos to write changelog.		Use SVN log over both repos to write changelog.
	Try to write in language which users can understand, whenever possible.		<br>Try to write in language which users can understand, whenever possible.
	Post as many links as you can: links to the issue in the [https://bugs.thedarkmod.com/my_view_page.php bugtracker site] as especially welcome, or links to feature discussion thread.		<br>Post as many links as you can: links to the issue in the [https://bugs.thedarkmod.com/my_view_page.php bugtracker site] as especially welcome, or links to feature discussion thread.
	Some very minor things can be omitted in changelog, but don't miss anything which can break something or cause any type of negative consequences.		<br>Some very minor things can be omitted in changelog, but don't miss anything which can break something or cause any type of negative consequences.
	Most likely you will often read this changelog yourself =)		<br>Most likely you will often read this changelog yourself =)

	When changelog is ready, post short message that new version is available in the appropriate forum thread.		When changelog is ready, post short message that new version is available in the appropriate forum thread.


	=== Dev Build: Recap ===		=== Dev Build: Recap ===

Nbohr1more at 02:08, 11 June 2024

2024-06-11T02:08:03Z

← Older revision		Revision as of 02:08, 11 June 2024
Line 248:		Line 248:
	Use SVN log over both repos to write changelog.		Use SVN log over both repos to write changelog.
	Try to write in language which users can understand, whenever possible.		Try to write in language which users can understand, whenever possible.
	Post as ~~much~~ links as you can: links to bugtracker as especially welcome, or links to feature discussion thread.		Post as many links as you can: links to the issue in the [https://bugs.thedarkmod.com/my_view_page.php bugtracker site] as especially welcome, or links to feature discussion thread.
	Some very minor things can be omitted in changelog, but don't miss anything which can break something or cause any type of negative consequences.		Some very minor things can be omitted in changelog, but don't miss anything which can break something or cause any type of negative consequences.
	Most likely you will often read this changelog yourself =)		Most likely you will often read this changelog yourself =)

Nbohr1more: /* Dev Builds */

2024-06-11T02:05:32Z

Dev Builds

← Older revision		Revision as of 02:05, 11 June 2024
Line 99:		Line 99:

	New development build/release is created roughly every 2-4 weeks (might depend on the amount of changes) from trunk.		New development build/release is created roughly every 2-4 weeks (might depend on the amount of changes) from trunk.
	<br>Even though these builds are unstable and untested, and may include features that will be heavily changed or even removed		<br>Even though these builds are unstable and untested, and may include features that will be heavily changed (or even removed)
	<br>by the time of the next major release, there are many reasons to provide them:		<br>by the time of the next major release, there are many reasons to provide them:
	<br>		<br>

Nbohr1more: /* Dev Builds */

2024-06-11T02:05:03Z

Dev Builds

← Older revision		Revision as of 02:05, 11 June 2024
Line 98:		Line 98:
	=== Dev Builds ===		=== Dev Builds ===

	New development build/release is created roughly every 2-4 weeks (might depend on the amount of changes) from trunk. Even though these builds are unstable and untested, and may include features will be heavily changed of even removed by the time of the next major release, there are many reasons to provide them:		New development build/release is created roughly every 2-4 weeks (might depend on the amount of changes) from trunk.
			<br>Even though these builds are unstable and untested, and may include features that will be heavily changed or even removed
			<br>by the time of the next major release, there are many reasons to provide them:
			<br>
	* Beta-testers are able to bisect over development history to find when an issue started happening.		* Beta-testers are able to bisect over development history to find when an issue started happening.
	* External programmers can get assets compatible with recent source code trunk.		* External programmers can get assets compatible with recent source code trunk.
Line 105:		Line 108:
	The rest of this chapter describes how to create such a dev build.		The rest of this chapter describes how to create such a dev build.
	Note: mostly the same steps are done when building beta releases and major releases.		Note: mostly the same steps are done when building beta releases and major releases.


	=== Compile Game Binaries ===		=== Compile Game Binaries ===

Stgatilov: Updated packager build instructions (#5076 is done).

2023-12-16T13:59:24Z

Updated packager build instructions (#5076 is done).

← Older revision		Revision as of 13:59, 16 December 2023
Line 14:		Line 14:


	The source code is located in source code SVN in <tt>~~tdm_update~~</tt> subdirectory.		The source code is located in source code SVN in <tt>tdm_package</tt> subdirectory.
	~~Build instructions~~:		It is built using CMake both on Windows and Linux, without any special details.
	* ~~Windows: Open~~ <tt>~~tdm_update~~.~~sln~~</tt>, build ~~Release~~ configuration
	* Linux: ~~Run~~ <tt>~~scons BUILD="release"~~</tt>		For instance:
	As the ~~result~~, packager executable <tt>tdm_package.???</tt> ~~will be created~~ in <tt>~~bin~~</tt> subdirectory.		* Run cmake-gui.
			* Point "Where is the source code" to <tt>tdm_package</tt> directory.
			* Point "Where to build the binaries" to <tt>tdm_package/output</tt> directory.
			* Click "Configure" button, select the compiler & platform you need.
			* Click "Finish".
			* Click "Generate", and you should get build files in <tt>output</tt> subdirectory.
			* Build:
			** On Windows: click "Open Project", select "RelWithDebInfo" configuration and use "Build -> Build Solution" option in menu.
			** On Linux: you should probably run "make" in the <tt>output</tt> subdirectory.

			In the end, find packager executable <tt>tdm_package.???</tt> in the <tt>output</tt> subdirectory.


	If the packager tool is modified, update the prebuilt executable on TDM server.		If the packager tool is modified, update the prebuilt executable on TDM server.
	Contact admin if you don't have SSH access for it.		Contact admin if you don't have SSH access for it.

	~~'''TODO:''' update this section when [https://bugs.thedarkmod.com/view.php?id=5076 #5076] is done.~~


	=== Zipsync ===		=== Zipsync ===

Stgatilov: 32-bit executables package: use https in download link

2023-02-05T11:10:56Z

32-bit executables package: use https in download link

← Older revision		Revision as of 11:10, 5 February 2023
Line 399:		Line 399:

	Also update the link to 32-bit executables.		Also update the link to 32-bit executables.
	It should point to <tt>~~http~~://update.thedarkmod.com/zipsync/_aux/XYY/tdm_exe32.zip</tt> --- that's where it was put inside the zipsync database.		It should point to <tt>https://update.thedarkmod.com/zipsync/_aux/XYY/tdm_exe32.zip</tt> --- that's where it was put inside the zipsync database.


	=== Update Wiki ===		=== Update Wiki ===

Stgatilov: Release debug symbols: save Windows and Linux, but x64 only

2023-02-05T11:02:04Z

Release debug symbols: save Windows and Linux, but x64 only

← Older revision		Revision as of 11:02, 5 February 2023
Line 376:		Line 376:

	The next thing is saving Windows debug symbols. You must have saved them when you built executables which are in the final package. If you did not save them, then you cannot simply publish the existing package, and you have to start over from section [[#Compile Game Binaries]].		The next thing is saving Windows debug symbols. You must have saved them when you built executables which are in the final package. If you did not save them, then you cannot simply publish the existing package, and you have to start over from section [[#Compile Game Binaries]].
	Compress ~~Windows~~ debug symbols (~~TheDarkMod~~.pdb and ~~TheDarkModx64~~.~~pdb~~) with 7z, put them into devel/release/debugging/X.YY in assets repo. Commit them to both to trunk and to release branch (commit + merge).		Compress debug symbols (TheDarkModx64.pdb and thedarkmod.x64.debug) with 7z, put them into devel/release/debugging/X.YY in assets repo. Commit them to both to trunk and to release branch (commit + merge).

	Exact state of SVN repos should be saved for every major release.		Exact state of SVN repos should be saved for every major release.
Line 385:		Line 385:
	If you did not build 32-bit executables previously, build them exactly from the same source code which was used to build 64-bit executables.		If you did not build 32-bit executables previously, build them exactly from the same source code which was used to build 64-bit executables.
	Put them at <tt>_aux/XYY/tdm_exe32.zip</tt> in the zipsync database (where X.YY is the TDM version).		Put them at <tt>_aux/XYY/tdm_exe32.zip</tt> in the zipsync database (where X.YY is the TDM version).


	=== Update Website ===		=== Update Website ===

Stgatilov: Tracy issue is no longer present after library update

2023-01-29T18:07:01Z

Tracy issue is no longer present after library update

← Older revision		Revision as of 18:07, 29 January 2023
Line 319:		Line 319:
	On the other hand, the more unmerged commits you have, the more likely merge conflicts become.		On the other hand, the more unmerged commits you have, the more likely merge conflicts become.
	Refactoring, files renaming, and massive changes over the codebase are strongly discouraged.		Refactoring, files renaming, and massive changes over the codebase are strongly discouraged.


	~~=== Tracy and dbghelp.dll ===~~

	~~The game uses Tracy for in-game profiling since 2.10.~~
	~~Tracy is capable of collecting call stacks, and uses some new functions from <tt>dbghelp.dll</tt> to achieve that.~~
	~~These functions require version 6.2 of dbghelp.dll, but Windows 7 has only version 6.1 preinstalled by default.~~
	~~As the result, TDM does not boot on a fresh Windows 7 machine. See [https://github.com/wolfpld/tracy/issues/301 issue].~~

	~~The current workaround is to add <tt>#undef TRACY_HAS_CALLSTACK</tt> at the end of </tt>ThirdParty/artefacts/tracy/include/client/TracyCallstack.h</tt> '''on release branch'''.~~
	~~Unfortunately, this has to be done again for every major release, since we don't want to lose callstacks on trunk.~~

Stgatilov: Added section about Tracy and dbghelp.dll.

2021-12-19T13:13:12Z

Added section about Tracy and dbghelp.dll.

← Older revision		Revision as of 13:13, 19 December 2021
Line 319:		Line 319:
	On the other hand, the more unmerged commits you have, the more likely merge conflicts become.		On the other hand, the more unmerged commits you have, the more likely merge conflicts become.
	Refactoring, files renaming, and massive changes over the codebase are strongly discouraged.		Refactoring, files renaming, and massive changes over the codebase are strongly discouraged.


			=== Tracy and dbghelp.dll ===

			The game uses Tracy for in-game profiling since 2.10.
			Tracy is capable of collecting call stacks, and uses some new functions from <tt>dbghelp.dll</tt> to achieve that.
			These functions require version 6.2 of dbghelp.dll, but Windows 7 has only version 6.1 preinstalled by default.
			As the result, TDM does not boot on a fresh Windows 7 machine. See [https://github.com/wolfpld/tracy/issues/301 issue].

			The current workaround is to add <tt>#undef TRACY_HAS_CALLSTACK</tt> at the end of </tt>ThirdParty/artefacts/tracy/include/client/TracyCallstack.h</tt> '''on release branch'''.
			Unfortunately, this has to be done again for every major release, since we don't want to lose callstacks on trunk.


Line 363:		Line 374:
	After some number of fixes has been committed and merged to release branch, repeat again from section [[#Publish Beta Release]].		After some number of fixes has been committed and merged to release branch, repeat again from section [[#Publish Beta Release]].
	Publish new beta release, wait for feedback, fix, merge fixes to release branch, publish new release, etc.		Publish new beta release, wait for feedback, fix, merge fixes to release branch, publish new release, etc.



	= Major Release =		= Major Release =

Stgatilov: zipsync: MirrorSet replaced with Mirror-s

2021-05-27T13:47:31Z

zipsync: MirrorSet replaced with Mirror-s

← Older revision		Revision as of 13:47, 27 May 2021
Line 222:		Line 222:
	Then open <tt>tdm_installer.ini</tt> in text editor, find appropriate place for the new version, and add it there, e.g.:		Then open <tt>tdm_installer.ini</tt> in text editor, find appropriate place for the new version, and add it there, e.g.:
	[Version dev12345-9876]		[Version dev12345-9876]
	manifestUrl=${~~MS:TDM_MIRRORS~~}/dev/210/dev12345-9876_from_dev01234-8765/manifest.iniz		manifestUrl=${MIRROR}/dev/210/dev12345-9876_from_dev01234-8765/manifest.iniz
	depends=dev01234-8765		depends=dev01234-8765
	folder=dev/2.10		folder=dev/2.10
Line 228:		Line 228:
	Immediately after that try to switch some of your TDM installations to the new version using tdm_installer (with "Bitwise exact zips" flag).		Immediately after that try to switch some of your TDM installations to the new version using tdm_installer (with "Bitwise exact zips" flag).
	If something does not work for you, fix the problem as soon as possible.		If something does not work for you, fix the problem as soon as possible.


	=== Changelog and Announcement ===		=== Changelog and Announcement ===