Skip to content

Conversation

smk4664
Copy link
Contributor

@smk4664 smk4664 commented Jun 13, 2025

What's Changed

This adds a checker for the Compatibility Matrix docs. It tries to determine the minimum/maximum version of Nautobot from the Pyproject.toml (as the min/max version in the init.py could be going away). If you provide the --fix flag, it will add or update the line for the compatibility. This only checks the current version, it can't go back in time and check others. This also assumes that the last line is the version, which is the example, but may not be true in every repo.

EDIT:
I purposefully parse the pyproject.toml and compatibility_matrix.md with read instead of using a library like toml so that no additional packages need to be installed in the invoke library.

To Do

  • Explanation of Change(s)
  • Added change log fragment(s) (for more information see the documentation)
  • Attached Screenshots, Payload Example
  • Unit, Integration Tests
  • Documentation Updates (when adding/changing features)
  • Outline Remaining Work, Constraints from Design

This adds a checker for the Compatibility Matrix docs. It tries to determine the minimum/maximum version of Nautobot from the Pyproject.toml (as the min/max version in the __init__.py could be going away). If you provide the --fix flag, it will add or update the line for the compatibility. This only checks the current version, it can't go back in time and check others. This also assumes that the last line is the version, which is the example, but may not be true in every repo.
@smk4664 smk4664 requested a review from a team as a code owner June 13, 2025 19:28
Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link
Contributor

@gsnider2195 gsnider2195 left a comment

Choose a reason for hiding this comment

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

I haven't had a chance to review the code yet. Just some initial comments.

Copy link
Contributor

@gsnider2195 gsnider2195 left a comment

Choose a reason for hiding this comment

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

If you have time at the end of the sprint could you see if this could be trimmed down? This is a lot of code to add to the tasks.py

Co-authored-by: Gary Snider <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants