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.

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

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

Closed
kkthxbye-code opened this issue Aug 21, 2023 · 1 comment
Assignees
Labels
severity: medium Results in substantial degraded or broken functionality for specfic workflows type: bug A confirmed report of unexpected behavior in the application

Comments

@kkthxbye-code
Copy link
Contributor

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:

netbox-community/netbox-napalm-plugin#16

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

!!! tip "Accessing Config Parameters"
Plugin configuration parameters can be accessed using the `get_plugin_config()` function. For example:
```python
from extras.plugins import get_plugin_config
get_plugin_config('my_plugin', 'verbose_name')
```

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.

@kkthxbye-code kkthxbye-code added the type: documentation A change or addition to the documentation label Aug 21, 2023
@jeremystretch jeremystretch added type: bug A confirmed report of unexpected behavior in the application severity: medium Results in substantial degraded or broken functionality for specfic workflows and removed type: documentation A change or addition to the documentation labels Aug 22, 2023
@jeremystretch jeremystretch self-assigned this Aug 22, 2023
@jeremystretch
Copy link
Member

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
severity: medium Results in substantial degraded or broken functionality for specfic workflows type: bug A confirmed report of unexpected behavior in the application
Projects
None yet
Development

No branches or pull requests

2 participants