From 45779a24a40b4feefa9ed7bfd8eeffbfd7f902c2 Mon Sep 17 00:00:00 2001 From: Martin Hauser Date: Wed, 2 Apr 2025 21:41:36 +0200 Subject: [PATCH] docs(release): Update checklist with dependency requirements Add steps to update the dependency requirements matrix for each minor release in the release checklist. Clarify how to document changes for system requirements and linked installation guides. Fixes #18733 --- docs/development/release-checklist.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/development/release-checklist.md b/docs/development/release-checklist.md index 5b31a6391..c507a777a 100644 --- a/docs/development/release-checklist.md +++ b/docs/development/release-checklist.md @@ -31,6 +31,29 @@ Close the [release milestone](https://github.com/netbox-community/netbox/milesto Check that a link to the release notes for the new version is present in the navigation menu (defined in `mkdocs.yml`), and that a summary of all major new features has been added to `docs/index.md`. +### Adopt the Dependency Requirements Matrix + +For every minor release, update the dependency requirements matrix in `docs/installation/upgrading.md` ("All versions") to reflect the supported versions of Python, PostgreSQL, and Redis: + +1. Add a new row with the supported dependency versions. +2. Include a documentation link using the release tag format: `https://github.com/netbox-community/netbox/blob/v4.2.0/docs/installation/index.md` +3. Bold any version changes for clarity. + +**Example Update:** + +```markdown +| NetBox Version | Python min | Python max | PostgreSQL min | Redis min | Documentation | +|:--------------:|:----------:|:----------:|:--------------:|:---------:|:-------------------------------------------------------------------------------------------------:| +| 4.2 | 3.10 | 3.12 | **13** | 4.0 | [Link](https://github.com/netbox-community/netbox/blob/v4.2.0/docs/installation/index.md) | +``` + +### Update System Requirements + +If a new Django release is adopted or other major dependencies (Python, PostgreSQL, Redis) change: + +* Update the installation guide (`docs/installation/index.md`) with the new minimum versions. +* Update the upgrade guide (`docs/installation/upgrading.md`) for the current version accordingly. + ### Manually Perform a New Install Start the documentation server and navigate to the current version of the installation docs: