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

PR #13387 broke the documented get_plugin_config method as it is documented #8492

New Issue
Closed
opened 2025-12-29 20:37:24 +01:00 by adam · 1 comment
adam commented 2025-12-29 20:37:24 +01:00
Owner
Copy Link

Originally created by @kkthxbye-code on GitHub (Aug 21, 2023).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Correction

Area

Plugins

Proposed Changes

Not sure if this should be a bug report or a documentation change, as I'm not sure what the intention was. PR #13387 moved get_plugin_config from extras.plugins to extras.plugins.util. This seems like an undocumented backwards incompatible change to the plugin API. It broke netbox-napalm for instance:

https://github.com/netbox-community/netbox-napalm/issues/16

The change should either be rolled back or the documentation should be changed here:

4004966b16/docs/plugins/development/index.md (L119-L126)

If the change is to stay, we should edit the release notes on github for 3.5.8 indicating that there's a BC break.

Originally created by @kkthxbye-code on GitHub (Aug 21, 2023). Originally assigned to: @jeremystretch on GitHub. ### Change Type Correction ### Area Plugins ### Proposed Changes Not sure if this should be a bug report or a documentation change, as I'm not sure what the intention was. PR #13387 moved get_plugin_config from `extras.plugins` to `extras.plugins.util`. This seems like an undocumented backwards incompatible change to the plugin API. It broke netbox-napalm for instance: https://github.com/netbox-community/netbox-napalm/issues/16 The change should either be rolled back or the documentation should be changed here: https://github.com/netbox-community/netbox/blob/4004966b16269c96c09540c011a5aea2267bc226/docs/plugins/development/index.md?plain=1#L119-L126 If the change is to stay, we should edit the release notes on github for 3.5.8 indicating that there's a BC break.
adam added the type: bugseverity: medium labels 2025-12-29 20:37:24 +01:00
adam closed this issue 2025-12-29 20:37:24 +01:00
adam commented 2025-12-29 20:37:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 22, 2023):

This seems like an undocumented backwards incompatible change to the plugin API.

This was not intentional; it was an oversight on my part. We can fix it by importing the utility functions in extras.plugins.

@jeremystretch commented on GitHub (Aug 22, 2023): > This seems like an undocumented backwards incompatible change to the plugin API. This was not intentional; it was an oversight on my part. We can fix it by importing the utility functions in `extras.plugins`.
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 severity: medium type: bug
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#8492
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?