From c052e85afc494171ed79ff3600a405688cd1bb53 Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Fri, 13 Jan 2023 11:22:21 -0500 Subject: [PATCH] Minor fix to alpha versions in version scheme doc Signed-off-by: Andrew Richardson --- docs/contributors/version_scheme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/contributors/version_scheme.md b/docs/contributors/version_scheme.md index 2843a2f344..0cc8ce65ad 100644 --- a/docs/contributors/version_scheme.md +++ b/docs/contributors/version_scheme.md @@ -20,6 +20,7 @@ This page describes FireFly's versioning scheme --- ## Semantic versioning + FireFly follows [semantic versioning](https://semver.org/). In summary, this means: Given a version number MAJOR.MINOR.PATCH, increment the: @@ -32,7 +33,9 @@ Given a version number MAJOR.MINOR.PATCH, increment the: When creating a new release, the release name and tag should be the semantic version should be prefixed with a `v` . For example, a certain release name/tag could be `v0.9.0`. ## Pre-release test versions + For pre-release versions for testing, we append a date and index to the end of the most recently released version. For example, if we needed to create a pre-release based on `v0.9.0` and today's date is October 22, 2021, the version name/tag would be: `v0.9.0-20211022-01`. If for some reason you needed to create another pre-release version in the same day (hey, stuff happens), the name/tag for that one would be `v0.9.0-20211022-02`. ## Candidate releases -For pre-releases that are candidates to become a new major or minor release, the release name/tag will be based on the release that the candidate *will become* (as opposed to the test releases above, which are based on the previous release). For example, if the current latest release is `v0.9.0` but we want to create an alpha release for 1.0, the release name/tag would be `v1.0.0-alpha-01`. \ No newline at end of file + +For pre-releases that are candidates to become a new major or minor release, the release name/tag will be based on the release that the candidate _will become_ (as opposed to the test releases above, which are based on the previous release). For example, if the current latest release is `v0.9.0` but we want to create an alpha release for 1.0, the release name/tag would be `v1.0.0-alpha.1`.