-
Notifications
You must be signed in to change notification settings - Fork 3
Versioning
Daniel Gómez-Sánchez edited this page Apr 23, 2018
·
1 revision
Our versioning system for the user follows Semantic Versioning (SemVer) (MAJOR.MINOR.PATCH). A short with notable changes appears in each Release. All the changes can be found in the CHANGELOG, which is based on Keep a Changelog.
The meaning of each entry is user-based:
-
Fixed
: bug fixes. A PATCH release will be released just after their inclussion; if several bugs are reported in the same timeframe, a PATCH bump might include several fixes. -
Security
: fixes related with vulnerabilities. A PATCH release will be released just after their inclussion; if several bugs are reported in the same timeframe, a PATCH bump might include several fixes. -
Added
: new functionality compatible with previous versions. They increase the MINOR version. -
Changed
: rarely, we would include incompatible functionality (e.g., remove tools - see below). As they increase the MAJOR version, we try to minimize this changes. If the changes were related with beta tools this changes bumps the MINOR version. -
Deprecated
: production/beta tools (non experimental) that are not longer supported. They would exists until a MAJOR version is released, but they are not supported and will be removed. -
Removed
: tools removed. For production/beta tools, they were must beDeprecated
befor and they would bump the MAJOR version. For experimental tools, they might be removed without previous deprecation.
There is no implicit versioning for the developer. Nevertheless, we add a Developer
entry for refactoring and changes in the API to help downstream users to track breaking changes.