Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes #18733: Add Dependency Version Matrix for NetBox Versions to the Upgrade Documentation #19046

Merged
merged 4 commits into from
Apr 7, 2025
Merged

Fixes #18733: Add Dependency Version Matrix for NetBox Versions to the Upgrade Documentation #19046

merged 4 commits into from
Apr 7, 2025

Conversation

pheus
Copy link
Contributor

@pheus pheus commented Apr 1, 2025

Fixes: #18733

Summary

This PR introduces a dependency version matrix to the Upgrade Guide, providing a structured reference for verifying compatibility before upgrading. The matrix outlines the supported versions of Python, PostgreSQL, and Redis for each NetBox release, helping users avoid installation issues due to unsupported dependencies.

Changes

  • Added a toggleable version matrix to the upgrade guide, allowing users to switch between Current Version and All Versions instead of the initially proposed Current Version and Previous Versions. This makes it clearer and more useful for users looking for historical compatibility data.
  • Ensures that system requirements for each NetBox version are clearly documented in one place.

Screenshots

Screenshot 2025-04-01 at 08-54-46 Upgrading NetBox - NetBox Documentation

Screenshot 2025-04-01 at 08-55-17 Upgrading NetBox - NetBox Documentation

Would love any feedback on placement or formatting! 🚀

@pheus
docs(upgrading): Add dependency matrix for NetBox versions
a5106b8 
Adds a dependency matrix to the upgrade guide, detailing supported
Python, PostgreSQL, and Redis versions for each NetBox release. This
helps users verify compatibility before upgrading.

Fixes netbox-community#18733
@pheus
Copy link
Contributor Author

pheus commented Apr 1, 2025 •
edited
Loading

I'd like to point out that I targeted the main branch. If this PR gets merged into the feature branch instead, we should consider #18909, as that PR raises the minimum PostgreSQL version to 14.

Looking forward to your feedback, @jnovinger!

@jeremystretch jeremystretch requested review from a team and bctiemann and removed request for a team April 1, 2025 15:18
@jeremystretch
Copy link
Member

The documentation for cutting a new minor release should also be updated with instructions for updating the matrix.

@pheus
docs(release): Update checklist with dependency requirements
45779a2 
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 netbox-community#18733
@pheus
Copy link
Contributor Author

pheus commented Apr 2, 2025

Thanks for the feedback, @jeremystretch! That makes sense. I'll update the documentation for cutting a new minor release to include instructions for maintaining the matrix.

@pheus
Copy link
Contributor Author

pheus commented Apr 2, 2025

I've added instructions for updating the dependency requirements matrix to the release documentation. Let me know if any refinements are needed!
In the third commit, I made some smaller adjustments - if you don't find them useful, feel free to drop that commit.

bctiemann
bctiemann requested changes Apr 7, 2025
View reviewed changes
Copy link
Contributor

@bctiemann bctiemann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these changes are fine except I would prefer e.g. on its own without the comma; e.g., looks clumsy and feels unnecessary especially when it's used so frequently. Could you remove just those commas? Thanks!

@pheus pheus force-pushed the docs/18733-add-version-requirements-matrix branch from 28dfd22 to f8f5ab8 Compare April 7, 2025 14:56
@pheus pheus requested a review from bctiemann April 7, 2025 14:56
@pheus
Copy link
Contributor Author

pheus commented Apr 7, 2025

Sounds good - I’ve amended the last commit to drop the commas after e.g..
Thanks for the feedback!

@pheus
docs(release): Update Dependency Requirements Matrix header
10e1ae8 
Renames the "Adopt the Dependency Requirements Matrix" section to
"Update the Dependency Requirements Matrix" for clarity.
@pheus pheus requested a review from bctiemann April 7, 2025 15:18
@bctiemann bctiemann merged commit 2207ea1 into netbox-community:main Apr 7, 2025
@pheus pheus deleted the docs/18733-add-version-requirements-matrix branch April 7, 2025 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bctiemann bctiemann bctiemann approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a Version Requirements Matrix to the NetBox Upgrade Documentation
3 participants
@pheus @jeremystretch @bctiemann