starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Change the max_version check in the PluginConfig to exclude the specified version #5617

New Issue
Closed
opened 2025-12-29 19:30:11 +01:00 by adam · 2 comments
adam commented 2025-12-29 19:30:11 +01:00
Owner
Copy Link

Originally created by @tobiasge on GitHub (Nov 5, 2021).

NetBox version

v3.0.9

Feature type

Change to existing functionality

Proposed functionality

Change the max_version check in the PluginConfig to exclude the specified version or add a field to configure the behaviour.

Use case

When developing a plugin I want it to be compatible with all patch releases but not the next major version.
At the moment I can set the max_version to be '3.0.9' and the plugin will not work with '3.0.10'. With the proposed change I would set the max_version to '3.1' and the plugin would work with all minor versions of '3.0.x'.

Database changes

None

External dependencies

None

Originally created by @tobiasge on GitHub (Nov 5, 2021). ### NetBox version v3.0.9 ### Feature type Change to existing functionality ### Proposed functionality Change the `max_version` check in the `PluginConfig` to exclude the specified version or add a field to configure the behaviour. ### Use case When developing a plugin I want it to be compatible with all patch releases but not the next major version. At the moment I can set the `max_version` to be '3.0.9' and the plugin will not work with '3.0.10'. With the proposed change I would set the `max_version` to '3.1' and the plugin would work with all minor versions of '3.0.x'. ### Database changes None ### External dependencies None
adam added the type: feature label 2025-12-29 19:30:11 +01:00
adam closed this issue 2025-12-29 19:30:11 +01:00
adam commented 2025-12-29 19:30:12 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Nov 8, 2021):

I see two problems with this:

  1. It's rather misleading: One would expect the "max" version to be the highest most compatible version.
  2. It's a breaking change to the plugins API.

Instead, you can set max_version to e.g. 3.0.99 to ensure it will be supported up until v3.1. (This was a topic of conversation when the plugins API was being developed.)

@jeremystretch commented on GitHub (Nov 8, 2021): I see two problems with this: 1. It's rather misleading: One would expect the "max" version to be the highest most _compatible_ version. 2. It's a breaking change to the plugins API. Instead, you can set `max_version` to e.g. 3.0.99 to ensure it will be supported up until v3.1. (This was a topic of conversation when the plugins API was being developed.)
adam commented 2025-12-29 19:30:12 +01:00
Author
Owner
Copy Link

@tobiasge commented on GitHub (Nov 9, 2021):

Ye, it would be misleading. I think I can live with the proposed workaround.

@tobiasge commented on GitHub (Nov 9, 2021): Ye, it would be misleading. I think I can live with the proposed workaround.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#5617
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?