-
Notifications
You must be signed in to change notification settings - Fork 347
Releases
While this project is under active development we aim to make releases on roughly a 6 month cadence. Of course this is a goal, not a guarantee.
Our releases will follow the semantic versioning scheme. You can find a thorough description of this scheme here: semantic versioning. In short, this scheme has 3 parts to the version number: A.B.C
- A is the 'major' version, incremented when an API incompatible change is made
- B is the 'minor' version, incremented when an API compatible change is made
- C is the 'micro' version, incremented for bug fix releases
Please refer to the Semantic Versioning website for the authoritative description.
When a release is made a tag is created in the git repo identifying the release by version number (e.g. A.B.C where A, B and C are integers). NOTE that tags of this form should be considered immutable: If you are maintaining a build system / product that uses a specific version of this software you can rely on these tags to remain unchanged.
In the run up to a release the maintainers may create tags to identify progress toward the release. In these cases we will append a string to the release number to indicate progress using the generally accepted 'alpha' and 'beta' development stage identifiers. This string will take the form of '_(alpha|beta)X'. We append an incremental digit 'X' in case more than one tag is necessary to communicate progress as development moves forward. NOTE that tags of this form will be removed after a release with the corresponding version number has been made.
In the past we have made releases that deviate from this scheme. We provide a brief description of these releases for clarity / historical purposes.
The 1.0 release was made when the project was inherited by @flihp. It roughly corresponds to the 1.0 version of the TCGs TCTI / SAPI specification. The original intent was for the 1.0 release to be short lived but code quality issues with the resourcemgr , delays in the release of the next iteration of the TCG spec and user requests necessitated additional API compatible releases. There is currently a '1.x' branch tracking releases descendant from the 1.0 release tag.
This tag corresponds to the state of the source code was first made public by the original author (Will Arthur). It is NOT a supported release and should be considered deprecated. The version number corresponds to a numbering scheme used by the original author to track the progress of his own development. A record of his development efforts were transcribed into the CHANGELOG.md from a collection of release notes previously maintained in a MS Word document. This information was preserved for historical purposes / completeness only.