@@ -68,39 +68,42 @@ sources provides the following benefits:
6868LuxCoreDeps is exclusively intended to be run in continuous integration by
6969Github Actions. The main execution script is ` .github/workflows/deps.yml ` .
7070
71- Once built, dependencies are made available to LuxCore via LuxCoreDeps
72- ** releases** : https://github.com/LuxCoreRender/LuxCoreDeps/releases
73-
74-
7571To trigger dependency build & publish, use ** LuxCore Dependency Releaser** action,
7672with ` Run workflow ` button:
7773https://github.com/LuxCoreRender/LuxCoreDeps/actions/workflows/release.yml . This
78- action will build the dependency package and publish it in a release.
74+ action will build the dependency package and publish it in a release. Please follow
75+ semantic versioning when doing so.
7976
80- Please note that, for debugging purpose, dependency build is also triggered by
77+ Once built, dependencies are made available to LuxCore via LuxCoreDeps
78+ ** releases** : https://github.com/LuxCoreRender/LuxCoreDeps/releases
79+
80+ Note that, for debugging purpose, dependency build is also triggered by
8181` push ` events; however, in that case, no release is created.
8282
83- Please use Semantic Versioning (https://semver.org ).
8483
85- ## Adding Dependencies to LuxCoreDeps
84+
85+ ## Adding or Upgrading Dependencies in LuxCoreDeps
8686
8787_ (For admin only - requires appropriate rights on repository)_
8888
89- Dependencies can be added to LuxCoreDeps by upgrading the ` conanfile.py ` file,
90- located in the repository root.
89+ Dependencies can be added or upgraded in LuxCoreDeps by upgrading the ` conanfile.py `
90+ file, located in the repository root.
9191
9292Please refer to the Conan documentation for syntax of ` conanfile.py ` and instructions
9393how to modify such a file.
9494
9595
96- ## Caveats & Tips
96+ ## Tips & Caveats
9797
98- ### LuxCoreDeps Entry points
98+ ### Where to start - LuxCoreDeps entry points
9999The main entry point is ` .github/workflows/deps.yml ` .
100100Other interesting files may be:
101101- ` conanfile.py ` : Conan script to build dependencies
102102- ` conan-profiles ` : folder with Conan profiles
103103
104+ ### Versioning rules
105+ LuxCoreDeps follows Semantic Versioning (https://semver.org ).
106+
104107### Compilation environment
105108For Python wheels to be built properly, it is essential that dependencies be built
106109by ` CIBUILDWHEEL ` , with the same environment (compiler version, docker image,
@@ -115,8 +118,7 @@ However, a few ones did not exist on-the-shelf and were created as local recipes
115118Dependency build can be debugged locally using ` nektos/act `
116119(https://github.com/nektos/act ).
117120
118- In LuxCoreDeps repository, ` debug.sh ` contains a working example of ` act `
119- invokation under Linux.
121+ ` utils/debug.sh ` contains a working example of ` act ` invokation under Linux.
120122
121123## License
122124This code is released under Apache 2.0 license.
0 commit comments