Minor Version Bumps
Address Pinned Dependencies
base_requirements.txt for any dependencies pinned to a specific version, and upgrade them to their most stable release (where possible).
Link to the Release Notes Page
Add the release notes (
/docs/release-notes/X.Y.md) to the table of contents within
mkdocs.yml, and point
index.md to the new file.
Manually Perform a New Install
mkdocs in your local environment, then start the documentation server:
$ pip install -r docs/requirements.txt
$ mkdocs serve
Follow these instructions to perform a new installation of NetBox. 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.
Close the Release Milestone
Close the release milestone on GitHub after ensuring there are no remaining open issues associated with it.
Merge the Release Branch
Submit a pull request to merge the
feature branch into the
develop branch in preparation for its release.
Required Python packages are maintained in two files.
base_requirements.txt contains a list of all the packages required by NetBox. Some of them may be pinned to a specific version of the package due to a known issue. For example:
The other file is
requirements.txt, which lists each of the required packages pinned to its current stable version. When NetBox is installed, the Python environment is configured to match this file. This helps ensure that a new release of a dependency doesn't break NetBox.
Every release should refresh
requirements.txt so that it lists the most recent stable release of each package. To do this:
- Create a new virtual environment.
- Install the latest version of all required packages
pip install -U -r base_requirements.txt).
- Run all tests and check that the UI and API function as expected.
- Review each requirement's release notes for any breaking or otherwise noteworthy changes.
- Update the package versions in
In cases where upgrading a dependency to its most recent release is breaking, it should be pinned to its current minor version in
base_requirements.txt (with an explanatory comment) and revisited for the next major NetBox release.
Verify CI Build Status
Ensure that continuous integration testing on the
develop branch is completing successfully.
Update Version and Changelog
- Update the
settings.pyto the new release version.
- Update the example version numbers in the feature request and bug report templates under
- Replace the "FUTURE" placeholder in the release notes with the current date.
Commit these changes to the
Submit a Pull Request
Submit a pull request title "Release vX.Y.Z" to merge the
develop branch into
master. Copy the documented release notes into the pull request's body.
Once CI has completed on the PR, merge it.
Create a New Release
Draft a new release with the following parameters.
- Tag: Current version (e.g.
- Title: Version and date (e.g.
v2.9.9 - 2020-11-09)
Copy the description from the pull request to the release.
Update the Development Version
develop branch, update
settings.py to point to the next release. For example, if you just released v2.9.9, set:
VERSION = 'v2.9.10-dev'