diff options
| author | Javier Jardón <jjardon@gnome.org> | 2018-08-14 15:57:40 +0100 |
|---|---|---|
| committer | Javier Jardón <jjardon@gnome.org> | 2018-08-16 16:31:38 +0000 |
| commit | c225f30ae6cfe7ca90ca723ca182a968b05a1d08 (patch) | |
| tree | 754287e3aecc688b337898a08212736a56158f61 | |
| parent | 1e3e2a936d706509d4f75fa7181c9081ad6cfa40 (diff) | |
| download | buildstream-jjardon/doc_releases.tar.gz | |
Add section about current releasesjjardon/doc_releases
This is not ideal as the releases are hardcoded, but I think is better
than nothing until we got a solution to automate this
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/main_install.rst | 2 | ||||
| -rw-r--r-- | doc/source/main_releases.rst | 18 |
3 files changed, 21 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index ac4587f10..1e6e42dab 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,6 +18,7 @@ Later sections provide detailed information on BuildStream internals. :maxdepth: 1 main_about + main_releases main_install main_using main_core diff --git a/doc/source/main_install.rst b/doc/source/main_install.rst index 1a4895903..0cc567792 100644 --- a/doc/source/main_install.rst +++ b/doc/source/main_install.rst @@ -1,3 +1,5 @@ +.. _main_install: + Install ======= This section covers how to install BuildStream onto your machine, how to run diff --git a/doc/source/main_releases.rst b/doc/source/main_releases.rst new file mode 100644 index 000000000..62ea1c592 --- /dev/null +++ b/doc/source/main_releases.rst @@ -0,0 +1,18 @@ +Releases +======== +BuildStream follows the Semantic Versioning Convention `(SemVer) <https://semver.org/>`_ +for releases and development snapshops. + +For example, for a given version number ``X.Y.Z`` + * The ``X.<even number>.*`` versions are stable releases + * The ``X.<odd number>.*`` versions are development spanshots. + +Therefore, 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>`_ + * Latest release: `1.1.6 <https://gitlab.com/BuildStream/buildstream/tags/1.1.6>`_ + * `bst-1.0 (deprecated) <https://gitlab.com/BuildStream/buildstream/commits/bst-1.0>`_ + +Check the :ref:`BuildStream installation instructions <main_install>` for the different options to install them |