Skip to content

doc: keep the README release table in sync with the releases #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daniel-rossier merged 1 commit into from
Jul 15, 2026
+16 −1
Merged

doc: keep the README release table in sync with the releases #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ land there and are tagged as patch releases.

| Line | Branch | Latest release | Status |
|------|--------|----------------|--------|
| 6.2 | [`release/v6.2`](https://github.com/smartobjectoriented/so3/tree/release/v6.2) | [v6.2.1](https://github.com/smartobjectoriented/so3/releases/tag/v6.2.1) | Current stable |
| 6.2 | [`release/v6.2`](https://github.com/smartobjectoriented/so3/tree/release/v6.2) | [v6.2.3](https://github.com/smartobjectoriented/so3/releases/tag/v6.2.3) | Current stable |
| 6.1 | [`release/v6.1`](https://github.com/smartobjectoriented/so3/tree/release/v6.1) | [v6.1.0](https://github.com/smartobjectoriented/so3/releases/tag/v6.1.0) | Previous |
| 5.4 | [`release/v5.4`](https://github.com/smartobjectoriented/so3/tree/release/v5.4) | [v5.4.1](https://github.com/smartobjectoriented/so3/releases/tag/v5.4.1) | End of life |

Expand Down
15 changes: 15 additions & 0 deletions doc/source/release_process.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,21 @@ When ``main`` is ready for a new minor version, branch off it, then tag:
gh release create v6.3.0 --title "SO3 v6.3.0" \
--target release/v6.3 --latest --generate-notes

After tagging: propagate the release to ``main``
************************************************

A release is not finished when the tag is pushed. Two references to the
current version live on ``main`` and must be bumped right after every
release (they drift silently otherwise):

* the *Maintained versions* table in ``README.md`` (the *Latest release*
column of the line, and the *Status* column when a new minor line starts);
* the build-system version pins: rename the ``so3_X.Y.Z.bb`` and
``avz_X.Y.Z.bb`` recipes (under ``build/meta-so3/recipes-so3/``) to the
new version and update the ``PREFERRED_VERSION_so3`` /
``PREFERRED_VERSION_avz`` entries in ``build/conf/local.conf`` (see the
``v6.2.3`` bump for a template).

Rules of thumb
**************

Expand Down
Loading