|
1 |
| -# Releasing New Rez Versions |
| 1 | +# Release Procedures and standards for rez |
| 2 | + |
| 3 | +## Version nomenclature and release cadence |
| 4 | + |
| 5 | +### The meaning of the version parts |
| 6 | + |
| 7 | +rez releases observe the [semver 2.0.0](https://semver.org/) version numbering standard. |
| 8 | +Briefly: |
| 9 | + |
| 10 | +* **MAJOR** version when you make incompatible API changes |
| 11 | +* **MINOR** version when you add functionality in a backward compatible manner |
| 12 | +* **PATCH** version when you make backward compatible bug fixes |
| 13 | + |
| 14 | +### Cadence of releases |
| 15 | + |
| 16 | +Currently, rez is not considered a component that studios feel the need to |
| 17 | +include in the [VFX Reference Platform](https://vfxplatform.com/), although |
| 18 | +many do use rez to help manage migrations between and amongst subsequent |
| 19 | +iterations thereof. |
| 20 | + |
| 21 | +As such, rez currently releases on an as-needed basis, which is to say, at the |
| 22 | +discretion of the TSC. For the most part that means that: |
| 23 | + |
| 24 | +* When there is a bugfix for a recent feature version, releasing a "patch" |
| 25 | +bugfix version resolving the issue will be prioritized above new feature |
| 26 | +releases. |
| 27 | +* When there is a naturally occurring set of features or updates that are |
| 28 | +feature-complete, well-tested, self-contained, and ready to go, those will be |
| 29 | +released as a "minor" feature update. |
| 30 | +* When there is a "major" breaking change, it will be deferred for as reasonably |
| 31 | +long as possible. Strategies to make a breaking change into a non-breaking |
| 32 | +change will also be asked-for, investigated, and preferred. rez often has |
| 33 | +normally gone many years between breaking changes. |
| 34 | + |
| 35 | +## Procedures for Releasing New Rez Versions |
2 | 36 |
|
3 | 37 | To merge a PR to the `main` branch and release a new version:
|
4 | 38 |
|
|
0 commit comments