Deploying LuxCoreRender: Difference between revisions
No edit summary |
|||
| Line 20: | Line 20: | ||
= Prerequisites = | = Prerequisites = | ||
== | == Admin rights == | ||
The process requires that the administrator running the Release and Deploy process be: | The process requires that the administrator running the Release and Deploy process be: | ||
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc. | * granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc. | ||
| Line 29: | Line 29: | ||
Please check you are entitled with such rights. | Please check you are entitled with such rights. | ||
== | == Buildability == | ||
The process required that targeted LuxCore components are <i>buildable</i>. | The process required that targeted LuxCore components are <i>buildable</i>. | ||
| Line 41: | Line 41: | ||
Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above. | Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above. | ||
== | == 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 | |||
== Sufficient space on PyPI and PyPI-test == | |||
== | |||
= Procedure = | = Procedure = | ||
Revision as of 15:55, 19 April 2026
Audience and Scope
This document is intended to LuxCoreRender administrators only.
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
pyluxcore) - Samples (aka
luxcoreuiandluxcoreconsole) - BlendLuxCore
Please note we deliberately exclude the dependencies (aka LuxCoreDeps) 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.
Prerequisites
Admin rights
The process requires that the administrator running the Release and Deploy process 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 you are entitled with such rights.
Buildability
The process required that targeted LuxCore components are buildable.
The component must by buildable by Continuous Integration. This can be checked by running the following Github Actions:
- Wheels:
LuxCore Python Wheel Builder(in LuxCore repository) - Samples:
LuxCore Python Sample Builder(in LuxCore repository) - BlendLuxCore:
BlendLuxCore Build Bundle(in BlendLuxCore)
Please check the components fulfill those requirements before any Release/Deploy approach. This should be done by running the 3 actions above.
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