From 5047923fac745351f5a9b0e261134164d2d6f7c4 Mon Sep 17 00:00:00 2001 From: Nicola Date: Wed, 4 Dec 2024 15:20:40 +0100 Subject: [PATCH] release: remove LTS/STS terms (#730) --- docs/install/index.md | 4 +-- docs/maintenance/branch-management.md | 42 +++------------------------ docs/releases/maintenance-policy.md | 27 +++++------------ docs/releases/v12/version-v12.0.0.md | 4 +-- mkdocs.yml | 4 +-- 5 files changed, 17 insertions(+), 64 deletions(-) diff --git a/docs/install/index.md b/docs/install/index.md index de7e2513..814287ef 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -35,8 +35,8 @@ invenio-cli check-requirements Scaffold your InvenioRDM instance. Replace ```` with the version you want to install: -- LTS release (for production systems): ``v12.0`` -- STS release (for feature previews): ``v11.0`` +- latest release (for production systems): ``v12.0`` +- under development release (for feature previews): ``master`` ```shell invenio-cli init rdm -c diff --git a/docs/maintenance/branch-management.md b/docs/maintenance/branch-management.md index e05f7baf..6c9f8a19 100644 --- a/docs/maintenance/branch-management.md +++ b/docs/maintenance/branch-management.md @@ -11,11 +11,8 @@ the maintenance policy. ## Overview -An InvenioRDM Long-Term Support (LTS) release is supported for minimum 1 year -and for minimum 6 months after the next new LTS release (see -[maintenance policy](../releases/maintenance-policy.md)). Only the latest minor -version of an LTS release is supported (e.g. we do not support both v6.0 and -v6.1). +The latest InvenioRDM release is supported until the next release +(see [maintenance policy](../releases/maintenance-policy.md)). ### Opening pull requests @@ -49,37 +46,6 @@ maintained releases. The maintainer is free to ask the developer opening the PR to backport the fix, but it's the maintainer that's ultimately responsible for ensuring that the fix is backported. -#### Supported maintenance branches - -Following is an overview of which versions/branch(es) are currently supported for -InvenioRDM modules (see the currently supported InvenioRDM versions and their -end of life dates on the -[maintenance policy](../releases/maintenance-policy.md)). - -| Module | Supported versions | Supported branches | -| --------------------------- | ---------------------- | ------------------------------ | -| flask-resources | ``0.7.x``, ``0.8.x`` | ``maint-0.7``, ``maint-0.8`` | -| invenio-app-rdm | ``6.0.x``, ``8.0.x`` | ``maint-6.0``, ``maint-8.0`` | -| invenio-communities | ``2.5.x``, ``2.7.x`` | ``maint-2.5``, ``maint-2.7`` | -| invenio-drafts-resources | ``0.13.x``, ``0.15.x`` | ``maint-0.13``, ``maint-0.15`` | -| invenio-rdm-records | ``0.32.x``, ``0.34.x`` | ``maint-0.32``, ``maint-0.34`` | -| invenio-records-permissions | ``0.12.x``, ``0.13.x`` | ``maint-0.12``, ``maint-0.13`` | -| invenio-records-resources | ``0.16.x``, ``0.18.x`` | ``maint-0.16``, ``maint-0.18`` | -| invenio-requests | ``0.2.x`` | ``maint-0.2`` | -| invenio-s3 | ``1.0.x`` | ``maint-1.0`` | -| invenio-vocabularies | ``0.8.x``, ``0.10.x`` | ``maint-0.8``, ``maint-0.10`` | -| marshmallow-utils | ``0.5.x`` | ``maint-0.5`` | -| react-invenio-deposit | ``0.16.x``, ``0.17.x`` | ``maint-0.16``, ``maint-0.17`` | -| react-invenio-forms | ``0.8.x``, ``0.9.x`` | ``maint-0.8``, ``maint-0.9`` | - -!!! info "Didn't find the module?" - - If a module is not listed above, it is because the version is either - unconstrained or part of Invenio Framework and constrained by the Invenio - Framework setup. For unconstrained modules you should take great care that - the change/fix is backward compatible. If not, we have to constrain the - module version in one of the InvenioRDM modules. - ### Backporting Following is a small recipe for how to backport a fix: @@ -117,9 +83,9 @@ Once you have determined which major versions of InvenioRDM that are supported, you can start from ``invenio-app-rdm`` to figuoure out which module versions and branches that are supported and can update the table accordingly. -#### Create maintenance branches on LTS releases +#### Create maintenance branches on release -When a new LTS version is released, the release manager should go through all +When a new release is released, the release manager should go through all above repositories and create ``maint-x.y`` branches from the master/main branch. diff --git a/docs/releases/maintenance-policy.md b/docs/releases/maintenance-policy.md index 57aa2589..488775a5 100644 --- a/docs/releases/maintenance-policy.md +++ b/docs/releases/maintenance-policy.md @@ -1,14 +1,15 @@ # Maintenance policy -Our goal is to ensure that InvenioRDM **Long-Term Support releases** are supported with bug and security fixes for minimum one year after the release date and possibly longer. We aim at having new major releases every 3-months, especially in the early life of InvenioRDM. We strive our best to ensure that upgrades between major versions are fairly straight-forward to ensure users follow our latest releases. +Our goal is to ensure that the latest InvenioRDM release is supported with bug and security fixes for minimum one year after the release date, and possibly longer. +We aim at having a new release every year. We strive our best to ensure that upgrades between versions are fairly straight-forward to ensure users follow our latest releases. The maintenance policy is striving to strike a balance between maintaining a rock solid secure product while ensuring that users migrate to latest releases and ensuring that we have enough resources to actually support the maintenance policy. ## Policy -**Long-Term Support (LTS) releases:** A major version release may be designated as an LTS release. Only LTS releases should be used for production services. LTS releases are supported with bug and security fixes for a minimum of 1 year and possibly longer. An LTS release is supported for 6 months after the next LTS release. Only the latest minor-level release for the major version is supported. Example, if v6.0 is designated an LTS release, then only the latest v6.X release is maintained, as minor and patch-level releases +Starting with the v12 release, we have shifted from the Long-Term Support (LTS) and Short-Term Support (STS) model to aiming for one stable major release per year. -**Major release:** Major versions such as v3 allow us to introduce new features and make backward incompatible changes and remove deprecated features in a progressive manner. Only the latest minor-level release for each major version is supported. A major version release is supported until the next major version release (except for LTS designated releases). +**Major release:** Major versions such as v12 allow us to introduce new features, make backward incompatible changes and remove deprecated features in a progressive manner. Only the latest minor-level release for each major version is supported. A major version release is supported until the next major version release. **Minor releases:** Minor versions such as v3.1 allow us to introduce backward compatible changes in a manner that allow users to easily upgrade. @@ -22,20 +23,8 @@ Following is an overview of future end of life (EOL) dates for currently maintai | Release | Earliest EOL Date | Maintained until | | ----------- | ----------------- | ------------------- | -| v6.0.0 LTS | | 2022-12-31 | -| v9.0.0 LTS | 2023-05-24 | next LTS + 6 months | +| v12.0.0 | | next release | +| v11.0.0 STS | | next release | | v10.0.0 STS | | next SLS | - -### End of life releases - -The following releases have reached end of life: - -| Release | EOL Date | -| ------- | ---------- | -| v8.0.0 | 2022-06-01 | -| v7.0.0 | 2022-03-03 | -| v5.0.0 | 2021-08-05 | -| v4.0.0 | 2021-07-23 | -| v3.0.0 | 2021-05-28 | -| v2.0.0 | 2021-04-28 | -| v1.0.0 | 2021-03-26 | +| v9.0.0 LTS | 2023-05-24 | next LTS + 6 months | +| v6.0.0 LTS | | 2022-12-31 | diff --git a/docs/releases/v12/version-v12.0.0.md b/docs/releases/v12/version-v12.0.0.md index 74e3e322..d7863a95 100644 --- a/docs/releases/v12/version-v12.0.0.md +++ b/docs/releases/v12/version-v12.0.0.md @@ -2,9 +2,7 @@ _2024-07-31_ -_Long-term support (LTS) release_ - -We're happy to announce the release of InvenioRDM v12.0, the new much anticipated long-term support release! Version 12 will be maintained until at least 6 months following the next long-term support release. This also means that in February 2025, we will retire v9.1, the previous LTS. Visit our [maintenance policy page](../maintenance-policy.md) to learn more. +We're happy to announce the release of InvenioRDM v12.0, the new much anticipated release! Version 12 will be maintained until at least 6 months following the next release. This also means that in February 2025, we will retire v9.1, the previous LTS. Visit our [maintenance policy page](../maintenance-policy.md) to learn more. ## Try it diff --git a/mkdocs.yml b/mkdocs.yml index 5fc6b152..8e0beb07 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -200,10 +200,10 @@ nav: - Maintenance policy: releases/maintenance-policy.md - Upgrade policy: releases/upgrade-policy.md - Security policy: releases/security-policy.md - - WIP - Version v13.0 STS: + - Version v13.0: - Release Notes v13.0: releases/v13/version-v13.0.0.md - Upgrade from v12 to v13: releases/v13/upgrade-v13.0.md - - Version v12.0 LTS: + - Version v12.0: - Release Notes v12.0: releases/v12/version-v12.0.0.md - Upgrade from v11 to v12: releases/v12/upgrade-v12.0.md - Version v11.0 STS: