Deploying LuxCoreRender - Revision history

CodeHD: /* Documentation and Announcements */

2026-05-05T20:31:11Z

Documentation and Announcements

← Older revision		Revision as of 22:31, 5 May 2026
Line 159:		Line 159:

	== Documentation and Announcements ==		== Documentation and Announcements ==
	~~'''THIS SECTION IS WORK IN PROGRESS (CodeHD, 23.04.2026)'''~~

	Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.		Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.

CodeHD: /* Documentation and Announcements */

2026-05-05T20:30:54Z

Documentation and Announcements

← Older revision		Revision as of 22:30, 5 May 2026
Line 162:		Line 162:

	Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.		Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.
	Furthermore, the final step after release and deployment is to announce the release to the ~~communicate~~.		Furthermore, the final step after release and deployment is to announce the release to the community.

	The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:		The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:
	* This wiki		* This wiki, particularly
	** ~~particularly~~ the ~~pages linked on the front page~~		** Release notes
			** FAQ entries
			** Updates to the build process
			** Description of new features, API and SDL documentation
	* The project website		* The project website
	** particularly the downloads section		** particularly the downloads section
Line 174:		Line 177:
	* Announcement on the forums		* Announcement on the forums
	* Announcement in the discord channel		* Announcement in the discord channel
	* Announcement on Blenderartist		* Announcement on Blenderartist, ...

	During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.		During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.

	==== Alpha ====		==== Alpha ====
			* Update the release notes
			* Update the API/SDL description
			* Check the authors file and credits list
			* Brief GitHub release notes with warning labels about stability
			* Announcement on the most active user channels
			* Decide on final tasks/known bugs that shall be fixed during alpha/beta phase

	==== Beta ====		==== Beta ====
			* Keep updating release notes and API/SDL documentation
			* Update the Readme files in the code base
			* Start preparing a summary release notes for the GitHub release
			* Announcement of beta phase on more community channels
			* Complete all tasks for features/known bugfixes

	==== Release Candidate ====		==== Release Candidate ====
			* All documentation shall be updated fully
			* Update FAQs with feedback from alpha/beta phase
			* Double check authors and credits
			* GitHub release notes still should contain a warning label
			* Start preparing stable release announcement messages for all channels

	==== Stable (X.Y.0) ====		==== Stable (X.Y.0) ====
	~~At this point~~, ~~all~~		* Double-check all documentation
			* Prepare the final release notes summary
			* Create the release
			* Update the download section on the website
			* Create the announcement post on the forums
			* Finally, announce on Discord and optionally other sites

	==== Bugfix (X.Y.Z) ====		==== Bugfix (X.Y.Z) ====
Line 192:		Line 216:
	* Prepare a summary release notes targeted at users		* Prepare a summary release notes targeted at users
	** This needs to only include the incremental changes from the previous version		** This needs to only include the incremental changes from the previous version
	* Make a short announcement on the same channels as the ~~Stable~~ release		* Make a short announcement on the same channels as the for the stable release

CodeHD: /* Announcements */

2026-04-23T18:21:13Z

Announcements

@@ Line 158: / Line 158: @@
 * For latest releases, publish the files on the website
-== Announcements ==
+== Documentation and Announcements ==
-<To be completed by @codehd>
+'''THIS SECTION IS WORK IN PROGRESS (CodeHD, 23.04.2026)'''

Howetuft: /* Samples Release and Deployment */

2026-04-20T05:13:15Z

Samples Release and Deployment

← Older revision		Revision as of 07:13, 20 April 2026
Line 127:		Line 127:
	Branch: <i>main</i>		Branch: <i>main</i>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Update existing release (if any): <i>~~Unchecked~~</i>		Update existing release (if any): <i>unchecked</i>
	Rebuild all: <i>~~Unchecked~~</i>		Rebuild all: <i>unchecked</i>

	At this stage, a <i>draft release</i> should have been created.		At this stage, a <i>draft release</i> should have been created.

Howetuft: /* Wheels Release and Deployment */

2026-04-20T05:12:10Z

Wheels Release and Deployment

← Older revision		Revision as of 07:12, 20 April 2026
Line 89:		Line 89:
	Branch: <i><code>master</code></i>		Branch: <i><code>master</code></i>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Update existing release (if any): <i>~~Unchecked~~</i>		Update existing release (if any): <i>unchecked</i>
	Rebuild all: <i>~~Checked~~</i>		Rebuild all: <i>checked</i>

	This will build the wheels and create a release in draft mode.		This will build the wheels and create a release in draft mode.
Line 103:		Line 103:
	Branch: <i><code>master</code></i>		Branch: <i><code>master</code></i>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Run on PyPI test: <i>~~Checked~~</i>		Run on PyPI test: <i>checked</i>
	This will upload the wheels to PyPI test (deployment - test).		This will upload the wheels to PyPI test (deployment - test).
	This is a test step, to check everything is fine before uploadig to real PyPI.		This is a test step, to check everything is fine before uploadig to real PyPI.
Line 111:		Line 111:
	Branch: <code>master</code>		Branch: <code>master</code>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Run on PyPI test: <i>~~Unchecked~~</i>		Run on PyPI test: <i>unchecked</i>
	This will upload the wheels to PyPI (deployment).		This will upload the wheels to PyPI (deployment).

Howetuft: /* Wheels Release and Deployment */

2026-04-20T05:11:26Z

Wheels Release and Deployment

← Older revision		Revision as of 07:11, 20 April 2026
Line 87:		Line 87:

	* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:		* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:
	Branch: <code>master</code>		Branch: <i><code>master</code></i>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Update existing release (if any): <i>Unchecked</i>		Update existing release (if any): <i>Unchecked</i>

Howetuft: /* Wheels Release and Deployment */

2026-04-20T05:11:05Z

Wheels Release and Deployment

← Older revision		Revision as of 07:11, 20 April 2026
Line 84:		Line 84:
	== Wheels Release and Deployment ==		== Wheels Release and Deployment ==

	* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the targeted version number for ~~wheels~~.		* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the targeted version number for LuxCore.

	* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:		* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:

Howetuft: /* Pre-Flight Review */

2026-04-20T05:10:38Z

Pre-Flight Review

← Older revision		Revision as of 07:10, 20 April 2026
Line 77:		Line 77:
	* Check LuxCore buildability: run the 3 actions listed above.		* Check LuxCore buildability: run the 3 actions listed above.
	* Ensure the change log is available		* Ensure the change log is available
	* Define and check Release Version Numbers (one for LuxCore and one for BlendLuxCore): they should have been neither allocated before, ~~nor~~ used on PyPI.		* Define and check Release Version Numbers (one for LuxCore and one for BlendLuxCore): they should have been neither allocated before, and the LuxCore should not have been used on PyPI.
	* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.		* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Howetuft: /* Sufficient space on PyPI and PyPI-test */

2026-04-20T05:09:12Z

Sufficient space on PyPI and PyPI-test

← Older revision		Revision as of 07:09, 20 April 2026
Line 66:		Line 66:

	At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each): the space required for one release is about 1.5GB. As a consequence, the space sufficiency must be checked each time a version has to be deployed.		At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each): the space required for one release is about 1.5GB. As a consequence, the space sufficiency must be checked each time a version has to be deployed.

			Nota: this check is <i>critical</i> and should be done with care. If the upload to PyPI is interrupted halfway, for instance by lack of space, the version number will still become no more available.

	= Procedure =		= Procedure =

Howetuft: /* BlendLuxCore Release and Deployment */

2026-04-19T18:48:18Z

BlendLuxCore Release and Deployment

← Older revision		Revision as of 20:48, 19 April 2026
Line 139:		Line 139:


	* In <code>luxloader/__init__.py</code>, set <code>PYLUXCORE_VERSION</code> to the version of related <code>pyluxcore</code>. The version to use must be strictly the same the one that appears on PyPI. Please check syntax carefully, as PyPI may slightly modify version number when uploading.		* In <code>luxloader/__init__.py</code>, set <code>PYLUXCORE_VERSION</code> to the version of related <code>pyluxcore</code>. The version to use must be strictly the same as the one that appears on PyPI. Please check syntax carefully, as PyPI may slightly modify version number when uploading.

	* In <code>blender_manifest.toml</code>, set <code>version</code> parameter to the targeted version of BLC. Caveat: this version can differ from pyluxcore version defined above.		* In <code>blender_manifest.toml</code>, set <code>version</code> parameter to the targeted version of BLC. Caveat: this version can differ from pyluxcore version defined above.