From 89604ceade1a7021704dc2800a73e0aac80a0799 Mon Sep 17 00:00:00 2001 From: Brian Tiemann Date: Tue, 10 Sep 2024 18:42:49 -0400 Subject: [PATCH] Add a step to the release checklist documentation for testing migrations on all supported upgrade paths --- docs/development/release-checklist.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/development/release-checklist.md b/docs/development/release-checklist.md index 6f11cc37b..7c8c96f39 100644 --- a/docs/development/release-checklist.md +++ b/docs/development/release-checklist.md @@ -39,6 +39,10 @@ mkdocs serve Follow these instructions to perform a new installation of NetBox in a temporary environment. This process must not be automated: The goal of this step is to catch any errors or omissions in the documentation, and ensure that it is kept up-to-date for each release. Make any necessary changes to the documentation before proceeding with the release. +### Test Upgrade Paths + +Upgrading from a previous version typically involves database migrations, which must work without errors. Supported upgrade paths include from one minor version to another within the same major version (i.e. 4.0 to 4.1), as well as from the latest patch version of the previous minor version (i.e. 3.7 to 4.0 or to 4.1). Prior to release, test all these supported paths by loading demo data from the source version and performing a `./manage.py migrate`. + ### Merge the Release Branch Submit a pull request to merge the `feature` branch into the `develop` branch in preparation for its release. Once it has been merged, continue with the section for patch releases below.