Skip to content

Commit 142dbf9

Browse files
committed
doc/guides: move release_cycle to starlight
1 parent 703feab commit 142dbf9

File tree

3 files changed

+53
-58
lines changed

3 files changed

+53
-58
lines changed

doc/doxygen/src/release-cycle.md

Lines changed: 2 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,5 @@
11
Release cycle {#release-cycle}
22
=============
33

4-
RIOT has a new release every three months and is named after the month it
5-
was feature frozen in. E.g. `2021.01` was feature frozen in January 2021.
6-
Feature freeze means the branch off point of the `<YYYY.MM>-branch` with
7-
`<YYYY.MM>` being the releases name. As such, any new feature merged into the
8-
`master` after that point, will be part of the next release. That branch, which
9-
we will call the release branch in the following is then the stable branch of
10-
RIOT.
11-
12-
After feature freeze, the current release candidate in the release branch is
13-
tested heavily. For more information on the release testing, have a look at our
14-
[release specifications][release specs]. Bug fixes that are made during this
15-
testing period are back ported from `master` to the release branch and a new
16-
release candidate might be created when a certain milestone is found. If all
17-
major bugs are fixed, the new RIOT release is signed off by the appointed
18-
release manager, usually within 2 weeks after the feature freeze.
19-
More details and instructions for release managers can be found in the
20-
[managing a release guide].
21-
22-
RIOT follows a rolling release cycle, meaning, that support and bug fixes are
23-
only provided for the most current release.
24-
25-
Download a release {#download}
26-
==================
27-
28-
You can download the source code of our releases [via Github][releases] as ZIP
29-
file or tarball. Alternatively, you can check them out if you already cloned
30-
RIOT with Git:
31-
32-
~~~~~~~~~~~~~~~~~~~~
33-
$ git pull --tags
34-
$ git checkout <YYYY.MM>
35-
~~~~~~~~~~~~~~~~~~~~
36-
37-
Point releases and hot fixes {#point-releases}
38-
============================
39-
40-
For major bug fixes, we may provide a point release `YYYY.MM.N` which results in
41-
a new ZIP file or tarball over at the [release page][releases]. However, minor
42-
bug fixes are only pushed to the release branch. You can fetch that via Git
43-
using
44-
45-
~~~~~~~~~~~~~~~~~~~~
46-
$ git clone -b `<YYYY.MM>-branch` https://github.com/RIOT-OS/RIOT
47-
~~~~~~~~~~~~~~~~~~~~
48-
49-
or
50-
51-
~~~~~~~~~~~~~~~~~~~~
52-
$ git pull origin <YYYY.MM-branch>:<YYYY.MM-branch>
53-
$ git checkout <YYYY.MM-branch>
54-
~~~~~~~~~~~~~~~~~~~~
55-
56-
if you have RIOT already cloned.
57-
58-
[releases]: https://github.com/RIOT-OS/RIOT/releases
59-
[release specs]: https://github.com/RIOT-OS/Release-Specs
60-
[managing a release guide]: https://github.com/RIOT-OS/RIOT/tree/master/doc/guides/managing-a-release
4+
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/release_cycle/).
5+
This page will be removed after release 2026.04.

doc/guides/misc/release_cycle.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Release Cycle
3+
description: Information about the RIOT release cycle
4+
---
5+
6+
RIOT has a new release every three months, named after the month it was feature frozen in.
7+
For example, `2025.01` was feature frozen in January 2025. Feature freeze marks
8+
the branch-off point of the `<YYYY.MM>-branch`, where `<YYYY.MM>` is the release name.
9+
Any new features merged into `master` after that point will be part of the next release.
10+
This branch, referred to as the release branch, is the stable branch of RIOT.
11+
12+
After feature freeze, the current release candidate in the release branch undergoes extensive testing.
13+
For more information on the release testing, see our
14+
[release specifications](https://github.com/RIOT-OS/Release-Specs). Bug fixes made during this testing period
15+
are backported from `master` to the release branch, and new release candidates may be created
16+
when certain milestones are reached. Once all major bugs are fixed, the new RIOT release
17+
is signed off by the appointed release manager, typically within 2 weeks after the feature freeze.
18+
For more details and instructions for release managers, see the
19+
[managing a release guide](https://github.com/RIOT-OS/RIOT/tree/master/doc/guides/managing-a-release).
20+
21+
RIOT follows a rolling release cycle, meaning support and bug fixes are only provided
22+
for the most current release.
23+
24+
## Download a Release
25+
26+
You can download the source code of our releases
27+
[via GitHub](https://github.com/RIOT-OS/RIOT/releases) as a ZIP file or tarball.
28+
Alternatively, you can check them out if you've already cloned RIOT with Git:
29+
30+
```bash
31+
git pull --tags
32+
git checkout <YYYY.MM>
33+
```
34+
35+
## Point Releases and Hot Fixes
36+
37+
For major bug fixes, we may provide a point release `YYYY.MM.N`, resulting in a new ZIP file
38+
or tarball on the [release page](https://github.com/RIOT-OS/RIOT/releases). However,
39+
minor bug fixes are only pushed to the release branch. You can fetch that via Git using:
40+
41+
```bash
42+
git clone -b <YYYY.MM>-branch https://github.com/RIOT-OS/RIOT
43+
```
44+
45+
or if you have RIOT already cloned:
46+
47+
```bash
48+
git pull origin <YYYY.MM>-branch:<YYYY.MM>-branch
49+
git checkout <YYYY.MM>-branch
50+
```

doc/starlight/astro.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export default defineConfig({
9696
},
9797
{
9898
label: "Miscellaneous",
99-
items: ["misc/how_to_doc"],
99+
items: ["misc/release_cycle", "misc/how_to_doc"],
100100
},
101101
],
102102
customCss: ["./src/styles/custom.css", "./src/fonts/font-face.css"],

0 commit comments

Comments
 (0)