Merge pull request #565 from maykinmedia/feature/add-version-policy

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

Author: danielmursa-dev

.github/ISSUE_TEMPLATE/prepare-release.md

@@ -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

.github/workflows/quick-start.yml

@@ -32,4 +32,4 @@ jobs:
       - name: Build and start docker with RELEASE=${{ env.RELEASE_NEW }}
         run: |
           docker compose build --build-arg RELEASE=${{ env.RELEASE_NEW }} || ( docker compose logs > $GITHUB_STEP_SUMMARY && exit 1 )
-          docker compose up -d || ( docker compose logs > $GITHUB_STEP_SUMMARY && exit 1 )
+          docker compose up -d || ( docker compose logs > $GITHUB_STEP_SUMMARY && exit 1 )

docs/introduction/index.rst

@@ -7,4 +7,5 @@ Introduction
    :maxdepth: 1
    :caption: Further reading
 
-   uml-diagram
+   uml-diagram
+   versioning

docs/introduction/versioning.rst

@@ -0,0 +1,59 @@
+.. _versioning_policy:
+
+Versioning policy
+=================
+
+New version releases for Open Klant 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.
+
++-------+-----------+---------------+--------------------------+
+| Major | Minor     | Release date  | Supported until          |
++=======+===========+===============+==========================+
+| 2.x   |           |               |                          |
++-------+-----------+---------------+--------------------------+
+|       | 2.15.x    | 2026-02-06    | 2026-08-06               |
++-------+-----------+---------------+--------------------------+
+|       | 2.14.x    | 2025-12-01    | 2026-06-01               |
++-------+-----------+---------------+--------------------------+
+|       | 2.13.x    | 2025-10-03    | 2026-04-03               |
++-------+-----------+---------------+--------------------------+
+|       | 2.12.x    | 2025-08-28    | 2026-02-28               |
++-------+-----------+---------------+--------------------------+
+|       | 2.11.x    | 2025-08-05    | 2026-02-05               |
++-------+-----------+---------------+--------------------------+
+|       | 2.10.x    | 2025-07-04    | 2026-01-04               |
++-------+-----------+---------------+--------------------------+
+|       | 2.9.x     | 2025-05-28    | 2025-11-28               |
++-------+-----------+---------------+--------------------------+
+|       | 2.8.x     | 2025-05-14    | 2025-11-14               |
++-------+-----------+---------------+--------------------------+
+|       | 2.7.x     | 2025-04-03    | 2025-10-03               |
++-------+-----------+---------------+--------------------------+
+|       | 2.6.x     | 2025-03-04    | 2025-09-04               |
++-------+-----------+---------------+--------------------------+
+|       | 2.5.x     | 2025-01-28    | 2025-07-28               |
++-------+-----------+---------------+--------------------------+
+|       | 2.4.x     | 2024-11-26    | 2025-05-26               |
++-------+-----------+---------------+--------------------------+
+|       | 2.3.x     | 2024-10-04    | 2025-04-04               |
++-------+-----------+---------------+--------------------------+
+|       | 2.2.x     | 2024-09-05    | 2025-03-05               |
++-------+-----------+---------------+--------------------------+
+|       | 2.1.x     | 2024-07-16    | 2025-01-16               |
++-------+-----------+---------------+--------------------------+
+|       | 2.0.x     | 2024-03-15    | 2024-09-15               |
++-------+-----------+---------------+--------------------------+
+| 1.x   |           |               | 2026-03-15               |
++-------+-----------+---------------+--------------------------+
+|       | 1.0.x     | 2023-02-16    | 2023-08-16               |
++-------+-----------+---------------+--------------------------+