summaryrefslogtreecommitdiff
path: root/doc/source/install_versions.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/install_versions.rst')
-rw-r--r--doc/source/install_versions.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/source/install_versions.rst b/doc/source/install_versions.rst
new file mode 100644
index 000000000..381b4ec44
--- /dev/null
+++ b/doc/source/install_versions.rst
@@ -0,0 +1,18 @@
+
+
+Semantic Versioning
+===================
+BuildStream follows the Semantic Versioning Convention `(SemVer) <https://semver.org/>`_,
+and uses even minor point numbers to denote releases intended for users while
+odd minor point numbers represent development snapshops.
+
+For example, for a given version number ``X.Y.Z``
+ * The ``X.<even number>.*`` versions are releases intended for users.
+ * The ``X.<odd number>.*`` versions are development spanshots intended for testing.
+
+If you are :ref:`installing from git <install_git_checkout>`, please look for the latest
+tag in the latest release branch to ensure you're getting the latest release.
+
+Current release branches:
+ * `bst-1.2 (latest) <https://gitlab.com/BuildStream/buildstream/commits/bst-1.2>`_
+ * `bst-1.0 (deprecated) <https://gitlab.com/BuildStream/buildstream/commits/bst-1.0>`_