This document outlines version policies that will be upheld with Temporal V2 and all future Temporal releases. It is a reduced public version of an internal document.
Versions are denoted as MAJOR.MINOR.PATCH, and are updated as follows:
PATCH: incremented for bug fixes in any Temporal projectMINOR: incremented for feature additions in any Temporal project. When this occurs, all projects will receive the same version increment.MAJOR: incremented for backwards-incompatible ("breaking") changes in any Temporal project. When this occurs, all projects will receive the same version increment.
"Temporal projects" are all projects and packages related to Temporal. These include:
These can be found under the temporal tag
on the RTrade GitHub account.
We have a number of experimental pre-release projects that are currently
available. These projects are released as v0.x.x projects, and are not under
the same versioning and compatibility guarantees as released projects. These
projects include:
When these projects are finalized and production-ready, they will be tagged with
the same MAJOR.MINOR version as the released projects.
This is primarily my (postables/alex) "fault". For awhile I was the only developer
on Temporal, and it was still pretty unclear until recently (around September)
whether or not we would actually go ahead and pursue Temporal beyond just a hobby
project. As such I haphazardly handled versioning. Onboarding Robert allowed us
to iron out these inconsistencies and establish some solid ground rules for
handling versioning, and other code hygiene habits. As such, the current version
of Temporal can effectively be considered V1.
Temporal projects will have 2 branches: master, a stable branch which maintains
the state of production releases, and dev, a semi-stable branch that tracks
work-in-progress features.