Skip to content

📝 [maykinmedia/open-api-framework#205] Describe version policy + supported versions in documentation #729

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
stevenbal merged 2 commits into from
Feb 12, 2026
+99 −0
Merged

📝 [maykinmedia/open-api-framework#205] Describe version policy + supported versions in documentation #729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
027e00d
:memo: [maykinmedia/open-api-framework#205] Describe version policy +…
danielmursa-dev Feb 12, 2026
3a27527
:rotating_light: Add ``opentelemetry`` docs to linkcheck_ignore
danielmursa-dev Feb 12, 2026
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/prepare-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ projects: ["maykinmedia/15"]
- [ ] Update READMEs with release dates + links
- [ ] Bump version number with `bin/bump-my-version.sh bump <major|minor|patch>`
- [ ] Update changelog
- [ ] Update ``docs/introduction/versioning.rst``
- [ ] Check the impact of this release on the Helm charts and make issues for this in https://github.com/maykinmedia/charts if needed, e.g.
- [ ] New environment variables were added
- [ ] New setup configuration steps or changes to format
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@
"https://sparxsystems.com/products/ea/trial/request.html", # this raises 403 for crawlers probably?
"https://data.overheid.nl/",
"https://github.com/maykinmedia/django-setup-configuration/blob/main/README.rst#environment-variable-substitution",
r"https://opentelemetry\.io/docs/.*", # times out frequently, even with 30s timeouts
]

extlinks = {
Expand Down
1 change: 1 addition & 0 deletions docs/introduction/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,5 @@ configuration or development needed.
features
team
open-source/index
versioning

96 changes: 96 additions & 0 deletions docs/introduction/versioning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
.. _versioning_policy:

Versioning policy
=================

New version releases for Objects API and Objecttypes API are done every two months, at the start of the month.
Major releases occur every two years.

Each major version is supported until 24 months after the release of the next major version.
The most recent major version is supported without a fixed end date until a new major version is released.
Each minor version within a supported major version is supported until 6 months after its release.

Only the latest version (the numbered version, not the technical latest-tag)
is actively maintained and under active development. Older versions only receive patches

The table below shows each major and minor version and until what date they can receive
patches.

Objects API
===========

+-------+---------+---------------+--------------------------+
| Major | Minor | Release date | Supported until |
+=======+=========+===============+==========================+
| 3.x | | | |
+-------+---------+---------------+--------------------------+
| | 3.6.x | 2026-02-06 | 2026-08-06 |
+-------+---------+---------------+--------------------------+
| | 3.5.x | 2025-12-01 | 2026-06-01 |
+-------+---------+---------------+--------------------------+
| | 3.4.x | 2025-10-28 | 2026-04-28 |
+-------+---------+---------------+--------------------------+
| | 3.3.x | 2025-10-06 | 2026-04-06 |
+-------+---------+---------------+--------------------------+
| | 3.2.x | 2025-09-16 | 2026-03-16 |
+-------+---------+---------------+--------------------------+
| | 3.1.x | 2025-05-26 | 2025-11-26 |
+-------+---------+---------------+--------------------------+
| | 3.0.x | 2025-01-22 | 2025-07-22 |
+-------+---------+---------------+--------------------------+
| 2.x | | | 2027-01-22 |
+-------+---------+---------------+--------------------------+
| | 2.5.x | 2025-01-09 | 2025-07-09 |
+-------+---------+---------------+--------------------------+
| | 2.4.x | 2024-07-05 | 2025-01-05 |
+-------+---------+---------------+--------------------------+
| | 2.3.x | 2024-03-15 | 2024-09-15 |
+-------+---------+---------------+--------------------------+
| | 2.2.x | 2024-01-30 | 2024-07-30 |
+-------+---------+---------------+--------------------------+
| | 2.1.x | 2022-05-17 | 2022-11-17 |
+-------+---------+---------------+--------------------------+
| | 2.0.x | 2021-09-22 | 2022-03-22 |
+-------+---------+---------------+--------------------------+
| 1.x | | | 2023-09-22 |
+-------+---------+---------------+--------------------------+
| | 1.1.x | 2021-04-21 | 2021-10-21 |
+-------+---------+---------------+--------------------------+
| | 1.0.x | 2021-01-13 | 2021-07-13 |
+-------+---------+---------------+--------------------------+


Objecttypes API
===============

+-------+---------+---------------+--------------------------+
| Major | Minor | Release date | Supported until |
+=======+=========+===============+==========================+
| 3.x | | | |
+-------+---------+---------------+--------------------------+
| | 3.4.x | 2025-12-01 | 2026-06-01 |
+-------+---------+---------------+--------------------------+
| | 3.3.x | 2025-10-06 | 2026-04-06 |
+-------+---------+---------------+--------------------------+
| | 3.2.x | 2025-08-07 | 2026-02-07 |
+-------+---------+---------------+--------------------------+
| | 3.1.x | 2025-07-10 | 2026-01-10 |
+-------+---------+---------------+--------------------------+
| | 3.0.x | 2025-01-22 | 2025-07-22 |
+-------+---------+---------------+--------------------------+
| 2.x | | | 2027-01-22 |
+-------+---------+---------------+--------------------------+
| | 2.3.x | 2025-01-10 | 2025-07-10 |
+-------+---------+---------------+--------------------------+
| | 2.2.x | 2024-06-27 | 2024-12-27 |
+-------+---------+---------------+--------------------------+
| | 2.1.x | 2022-06-24 | 2022-12-24 |
+-------+---------+---------------+--------------------------+
| | 2.0.x | 2021-10-04 | 2022-04-04 |
+-------+---------+---------------+--------------------------+
| 1.x | | | 2023-10-04 |
+-------+---------+---------------+--------------------------+
| | 1.1.x | 2021-04-21 | 2021-10-21 |
+-------+---------+---------------+--------------------------+
| | 1.0.x | 2021-01-13 | 2021-07-13 |
+-------+---------+---------------+--------------------------+
Loading