LuxCoreRender Wiki - User contributions [en]

LuxCoreRender Wiki

2026-04-22T19:04:24Z

Howetuft: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== LuxCore and BlendLuxCore Documentation ===

==== Building & Debugging ====
* [[ Building_LuxCoreRender | Building LuxCoreRender ]]
* [[ Developing and debugging BlendLuxCore ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging ]]
* [[ C++ Coding Guidelines ]]

==== Deploying ====
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]

==== Maintaining ====
* [[ Regular Maintenance Tasks ]]

==== Interfacing ====
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]

==== Legacy ====
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Wiki

2026-04-22T19:03:55Z

Howetuft: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

==== Building & Debugging ====
* [[ Building_LuxCoreRender | Building LuxCoreRender ]]
* [[ Developing and debugging BlendLuxCore ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging ]]
* [[ C++ Coding Guidelines ]]

==== Deploying ====
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]

==== Maintaining ====
* [[ Regular Maintenance Tasks ]]

==== Interfacing ====
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]

==== Legacy ====
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Wiki

2026-04-22T19:03:27Z

Howetuft: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

==== Building & Debugging ====
* [[ Building_LuxCoreRender | Building LuxCoreRender ]]
* [[ Developing and debugging BlendLuxCore ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging ]]
* [[ C++ Coding Guidelines ]]

==== Deploying ====
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]

==== Maintaining ====
* [[ Regular Maintenance Tasks ]]

==== Interfacing ====
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]

==== Legacy ====
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Wiki

2026-04-22T18:59:21Z

Howetuft: /* LuxCore */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

==== pyLuxCore ====
* [[ Building_LuxCoreRender | Building pyLuxCore ]]

* [[ C++ Coding Guidelines ]]
* [[ Regular Maintenance Tasks ]]

==== BlendLuxCore ====
* [[ Developing and debugging BlendLuxCore ]]

==== Common ====
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging ]]
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Wiki

2026-04-22T18:59:02Z

Howetuft: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

==== LuxCore ====
* [[ Building_LuxCoreRender | Building LuxCore ]]

* [[ C++ Coding Guidelines ]]
* [[ Regular Maintenance Tasks ]]

==== BlendLuxCore ====
* [[ Developing and debugging BlendLuxCore ]]

==== Common ====
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging ]]
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Wiki

2026-04-22T18:57:29Z

Howetuft: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

==== LuxCore ====
* [[ Building_LuxCoreRender | Building LuxCoreRender ]]
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ C++ Coding Guidelines ]]
* [[ Regular Maintenance Tasks ]]

==== BlendLuxCore ====
* [[ Developing and debugging BlendLuxCore ]]

==== Common ====
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging ]]
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Wiki

2026-04-22T18:55:50Z

Howetuft: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

==== LuxCore ====
* [[ Building_LuxCoreRender | Building LuxCoreRender ]]
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging LuxCoreRender ]]
* [[ C++ Coding Guidelines ]]
* [[ Regular Maintenance Tasks ]]

==== BlendLuxCore ====
* [[ Developing and debugging BlendLuxCore ]]

==== Common ====
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Wiki

2026-04-22T18:54:30Z

Howetuft: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

==== LuxCore ====
* [[ Building_LuxCoreRender | Building LuxCoreRender ]]
* [[ Deploying LuxCoreRender | Releasing and Deploying LuxCoreRender ]]
* [[ Building LuxCoreRender - FAQ | FAQ - Building & Debugging LuxCoreRender ]]
* [[ C++ Coding Guidelines ]]
* [[ Regular Maintenance Tasks ]]

==== BlendLuxCore ====
* [[ Developing and debugging BlendLuxCore ]]
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

Deploying LuxCoreRender

2026-04-20T05:13:15Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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 critical 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 =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== Wheels Release and Deployment ==

* 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:
Branch: <code>master</code>
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: checked

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-20T05:12:10Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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 critical 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 =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== Wheels Release and Deployment ==

* 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:
Branch: <code>master</code>
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: checked

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-20T05:11:26Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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 critical 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 =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== Wheels Release and Deployment ==

* 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:
Branch: <code>master</code>
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Checked

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-20T05:11:05Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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 critical 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 =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== Wheels Release and Deployment ==

* 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:
Branch: <code>master</code>
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Checked

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-20T05:10:38Z

Howetuft: /* Pre-Flight Review */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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 critical 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 =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-20T05:09:12Z

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

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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 critical 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 =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:48:18Z

Howetuft: /* BlendLuxCore Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:47:53Z

Howetuft: /* BlendLuxCore Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:46:49Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:45:43Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
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.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:44:50Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:44:35Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them, through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:43:38Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:42:52Z

Howetuft: /* Pre-Flight Review */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:41:48Z

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

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:40:59Z

Howetuft: /* Consistent Version Numbers */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each), so 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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:39:30Z

Howetuft: /* LuxCore Buildability */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each), so 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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T18:38:36Z

Howetuft: /* Clean Branches */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy activity.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each), so 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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:29:50Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy activity.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each), so 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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:28:59Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy activity.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each), so 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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text. Save the release.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:28:29Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy activity.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each), so 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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== 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.

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:28:01Z

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

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy activity.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each), so 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.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:26:07Z

Howetuft: /* Consistent Version Numbers */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy activity.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:25:05Z

Howetuft: /* LuxCore Buildability */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy activity.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:24:36Z

Howetuft: /* LuxCore Buildability */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:23:51Z

Howetuft: /* Clean Branches */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:23:36Z

Howetuft: /* Clean Branches */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:20:42Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:20:19Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples at this stage...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:19:51Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing)

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:17:57Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

(this step may not be mandatory for alpha releases, as the vast majority of alpha testers use Blender for testing)

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked
Nota: we assume the wheels have just been released, so that it is possible to reuse their build artifacts and thus to clear 'rebuild all'.

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:17:05Z

Howetuft: /* Samples Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

(this step may not be mandatory for alpha releases, as the vast majority of alpha testers use Blender for testing)

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked
Rebuild all: Unchecked
(nota: we assume the wheels have just been released, so that it is possible to reuse their build artifacts and not to rebuild all).

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:08:59Z

Howetuft: /* BlendLuxCore Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:08:36Z

Howetuft: /* Annoucements */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the bundle on the website

== Announcements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T16:05:25Z

Howetuft: /* BlendLuxCore Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the bundle on the website

== Annoucements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T15:33:23Z

Howetuft: /* BlendLuxCore Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log, set status to prerelease or latest release.

* For latest releases, publish the bundle on the website

== Annoucements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T15:28:15Z

Howetuft: /* BlendLuxCore Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
* Branch: main

== Annoucements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T15:25:58Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
* Branch: main

== Annoucements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T15:25:09Z

Howetuft: /* Wheels Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
* Version: the version number you selected before
* Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
* Branch: <code>master</code>
* Version: the version number you selected before
* Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
* Branch: main

== Annoucements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T15:24:51Z

Howetuft: /* BlendLuxCore Release and Deployment */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The following process assumes the releases are created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, make the required git plumbing.

== LuxCore Buildability ==

The process required that targeted LuxCore components be buildable.

The component must by buildable by Continuous Integration.
This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
You'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

This can look quite comfortable, however we must not forget we release 20 wheels each time (about 80-100MB each), so the space required for one release is 1.5GB!

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* 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.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the selected version number

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

This will build the wheels and create a release in draft mode.

* Open the draft release and set it to <code>prerelease</code> or <code>last release</code>. Also, insert the change log in the release text.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
* Branch: <code>master</code>
* Version: the version number you selected before
* Run on PyPI test: Checked
This will upload the wheels to PyPI test (deployment - test).
(this is a test step, before uploadig to real PyPI)

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
* Branch: <code>master</code>
* Version: the version number you selected before
* Run on PyPI test: Unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.

* 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>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.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
* Branch: main

== Annoucements ==
<To be completed by @codehd>

Deploying LuxCoreRender

2026-04-19T15:02:30Z

Howetuft: /* Procedure */

Deploying LuxCoreRender

2026-04-19T15:00:58Z

Howetuft: /* Wheels Release and Deployment */