From af7152eeca3ac906a1f673576d5c9cc343cbdd00 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Fri, 16 Apr 2021 17:42:11 +0200 Subject: [PATCH] doxygen: add release cycle page --- doc/doxygen/riot.doxyfile | 1 + doc/doxygen/src/release-cycle.md | 57 ++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 doc/doxygen/src/release-cycle.md diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index d6212b4ea255..96f46a9fdc0a 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -774,6 +774,7 @@ INPUT = ../../doc.txt \ src/using-cpp.md \ src/advanced-build-system-tricks.md \ src/emulators.md \ + src/release-cycle.md \ src/changelog.md \ ../../LOSTANDFOUND.md diff --git a/doc/doxygen/src/release-cycle.md b/doc/doxygen/src/release-cycle.md new file mode 100644 index 000000000000..97e0aa356869 --- /dev/null +++ b/doc/doxygen/src/release-cycle.md @@ -0,0 +1,57 @@ +Release cycle {#release-cycle} +============= + +RIOT has a new release every three months and is named after the month it +was feature frozen in. E.g. `2021.01` was feature frozen in January 2021. +Feature freeze means the branch off point of the `-branch` with +`` being the releases name. As such, any new feature merged into the +`master` after that point, will be part of the next release. That branch, which +we will call the release branch in the following is then the stable branch of +RIOT. + +After feature freeze, the current release candidate in the release branch is +tested heavily. For more information on the release testing, have a look at our +[release specifications][release specs]. Bug fixes that are made during this +testing period are back ported from `master` to the release branch and a new +release candidate might be created when a certain milestone is found. If all +major bugs are fixed, the new RIOT release is signed off by the appointed +release manager, usually within 2 weeks after the feature freeze. + +RIOT follows a rolling release cycle, meaning, that support and bug fixes are +only provided for the most current release. + +Download a release {#download} +================== + +You can download the source code of our releases [via Github][releases] as ZIP +file or tarball. Alternatively, you can check them out if you already cloned +RIOT with Git: + +~~~~~~~~~~~~~~~~~~~~ +$ git pull --tags +$ git checkout +~~~~~~~~~~~~~~~~~~~~ + +Point releases and hot fixes {#point-releases} +============================ + +For major bug fixes, we may provide a point release `YYYY.MM.N` which results in +a new ZIP file or tarball over at the [release page][releases]. However, minor +bug fixes are only pushed to the release branch. You can fetch that via Git +using + +~~~~~~~~~~~~~~~~~~~~ +$ git clone -b `-branch` https://github.com/RIOT-OS/RIOT +~~~~~~~~~~~~~~~~~~~~ + +or + +~~~~~~~~~~~~~~~~~~~~ +$ git pull origin : +$ git checkout +~~~~~~~~~~~~~~~~~~~~ + +if you have RIOT already cloned. + +[releases]: https://github.com/RIOT-OS/RIOT/releases +[release specs]: https://github.com/RIOT-OS/Release-Specs