Merge pull request #2794 from Ellipsanime/add-openpype-versionning-documentation

This commit is contained in:
Milan Kolar 2022-02-23 11:30:52 +01:00 committed by GitHub
commit a4b440d080
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -63,4 +63,18 @@ You can run OpenPype with `--use-staging` argument to add use staging versions.
:::note
Running staging version is identified by orange **P** icon in system tray.
:::
:::
### OpenPype versioning
OpenPype version control is based on semantic versioning.
:::note
The version of OpenPype is indicated by the variable `__version__` in the file `.\openpype\version.py`.
:::
For example OpenPype will consider the versions in this order: `3.8.0-nightly` < `3.8.0-nightly.1` < `3.8.0-rc.1` < `3.8.0` < `3.8.1-nightly.1` <`3.8.1` < `3.9.0` < `3.10.0` < `4.0.0`.
See https://semver.org/ for more details.
For studios customizing the source code of OpenPype, a practical approach could be to build by adding a name and a number after the PATCH and not to deploy 3.8.0 from original OpenPype repository. For example, your builds will be: `3.8.0-yourstudio.1` < `3.8.0-yourstudio.2` < `3.8.1-yourstudio.1`.