kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-28 07:51:19 +01:00
Code Releases Activity

doc/guides: move release_cycle to starlight

Browse Source
This commit is contained in:
AnnsAnn 2025-09-10 12:36:52 +02:00
parent 703feab3da
commit 142dbf9db9
3 changed files with 53 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
doc/doxygen/src/release-cycle.md
View File

@ -1,60 +1,5 @@
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 `<YYYY.MM>-branch` with
`<YYYY.MM>` 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.
More details and instructions for release managers can be found in the
[managing a release guide].
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 <YYYY.MM>
~~~~~~~~~~~~~~~~~~~~
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 `<YYYY.MM>-branch` https://github.com/RIOT-OS/RIOT
~~~~~~~~~~~~~~~~~~~~
or
~~~~~~~~~~~~~~~~~~~~
$ git pull origin <YYYY.MM-branch>:<YYYY.MM-branch>
$ git checkout <YYYY.MM-branch>
~~~~~~~~~~~~~~~~~~~~
if you have RIOT already cloned.
[releases]: https://github.com/RIOT-OS/RIOT/releases
[release specs]: https://github.com/RIOT-OS/Release-Specs
[managing a release guide]: https://github.com/RIOT-OS/RIOT/tree/master/doc/guides/managing-a-release
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/release_cycle/).
This page will be removed after release 2026.04.

50
doc/guides/misc/release_cycle.md Normal file
View File

@ -0,0 +1,50 @@
---
title: Release Cycle
description: Information about the RIOT release cycle
---
RIOT has a new release every three months, named after the month it was feature frozen in.
For example, `2025.01` was feature frozen in January 2025. Feature freeze marks
the branch-off point of the `<YYYY.MM>-branch`, where `<YYYY.MM>` is the release name.
Any new features merged into `master` after that point will be part of the next release.
This branch, referred to as the release branch, is the stable branch of RIOT.
After feature freeze, the current release candidate in the release branch undergoes extensive testing.
For more information on the release testing, see our
[release specifications](https://github.com/RIOT-OS/Release-Specs). Bug fixes made during this testing period
are backported from `master` to the release branch, and new release candidates may be created
when certain milestones are reached. Once all major bugs are fixed, the new RIOT release
is signed off by the appointed release manager, typically within 2 weeks after the feature freeze.
For more details and instructions for release managers, see the
[managing a release guide](https://github.com/RIOT-OS/RIOT/tree/master/doc/guides/managing-a-release).
RIOT follows a rolling release cycle, meaning support and bug fixes are only provided
for the most current release.
## Download a Release
You can download the source code of our releases
[via GitHub](https://github.com/RIOT-OS/RIOT/releases) as a ZIP file or tarball.
Alternatively, you can check them out if you've already cloned RIOT with Git:
```bash
git pull --tags
git checkout <YYYY.MM>
```
## Point Releases and Hot Fixes
For major bug fixes, we may provide a point release `YYYY.MM.N`, resulting in a new ZIP file
or tarball on the [release page](https://github.com/RIOT-OS/RIOT/releases). However,
minor bug fixes are only pushed to the release branch. You can fetch that via Git using:
```bash
git clone -b <YYYY.MM>-branch https://github.com/RIOT-OS/RIOT
```
or if you have RIOT already cloned:
```bash
git pull origin <YYYY.MM>-branch:<YYYY.MM>-branch
git checkout <YYYY.MM>-branch
```

2
doc/starlight/astro.config.mjs
View File

@ -96,7 +96,7 @@ export default defineConfig({
},
{
label: "Miscellaneous",
items: ["misc/how_to_doc"],
items: ["misc/release_cycle", "misc/how_to_doc"],
},
],
customCss: ["./src/styles/custom.css", "./src/fonts/font-face.css"],