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

Plugin events pipeline registration #9221

New Issue
Closed
opened 2025-12-29 20:47:12 +01:00 by adam · 3 comments
adam commented 2025-12-29 20:47:12 +01:00
Owner
Copy Link

Originally created by @natm on GitHub (Feb 8, 2024).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.7.2

Feature type

New functionality

Proposed functionality

3.7.0 introduced the events pipeline described in https://github.com/netbox-community/netbox/issues/14132

This involves making an entry in EVENTS_PIPELINE=[] within configuration.py, it would be more ergonomic if plugins could register for events by declaring intent within their configuration.

For example:

from netbox.plugins import PluginConfig

class FooBarConfig(PluginConfig):
    name = 'foo_bar'
    verbose_name = 'Foo Bar'
    description = 'An example NetBox plugin'
    version = '0.1'
    author = 'Jeremy Stretch'
    author_email = 'author@example.com'
    base_url = 'foo-bar'
    required_settings = []
    default_settings = {
        'baz': True
    }
    events_pipeline_registrations = [
         "foobar.mymodule.custom_event_handler"
    ]
    django_apps = ["foo", "bar", "baz"]

config = FooBarConfig

events_pipeline_registrations would be optional to allow for backwards compatibility and default to []

It would allow plugins which require access to the events pipeline to have entries added into EVENTS_PIPELINE automatically. This reduces complexity on those installing Netbox plugins which need events access.

https://linear.app/netboxlabs/issue/BIZ-6/

Use case

Simplify access to the events pipeline for plugins, reduce configuration complexity.

Database changes

No response

External dependencies

No response

Originally created by @natm on GitHub (Feb 8, 2024). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.7.2 ### Feature type New functionality ### Proposed functionality 3.7.0 introduced the events pipeline described in https://github.com/netbox-community/netbox/issues/14132 This involves making an entry in `EVENTS_PIPELINE=[]` within `configuration.py`, it would be more ergonomic if plugins could register for events by declaring intent within their configuration. For example: ```python from netbox.plugins import PluginConfig class FooBarConfig(PluginConfig): name = 'foo_bar' verbose_name = 'Foo Bar' description = 'An example NetBox plugin' version = '0.1' author = 'Jeremy Stretch' author_email = 'author@example.com' base_url = 'foo-bar' required_settings = [] default_settings = { 'baz': True } events_pipeline_registrations = [ "foobar.mymodule.custom_event_handler" ] django_apps = ["foo", "bar", "baz"] config = FooBarConfig ``` `events_pipeline_registrations` would be optional to allow for backwards compatibility and default to `[]` It would allow plugins which require access to the events pipeline to have entries added into `EVENTS_PIPELINE` automatically. This reduces complexity on those installing Netbox plugins which need events access. https://linear.app/netboxlabs/issue/BIZ-6/ ### Use case Simplify access to the events pipeline for plugins, reduce configuration complexity. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featuretopic: pluginscomplexity: medium labels 2025-12-29 20:47:12 +01:00
adam closed this issue 2025-12-29 20:47:12 +01:00
adam commented 2025-12-29 20:47:13 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Feb 8, 2024):

@arthanson does ordering matter in the EVENTS_PIPELINE list? Do we anticipate needing a mechanism to shape the smushing together of the per-plugin list with the one in configuration.py?

@jeffgdotorg commented on GitHub (Feb 8, 2024): @arthanson does ordering matter in the `EVENTS_PIPELINE` list? Do we anticipate needing a mechanism to shape the smushing together of the per-plugin list with the one in `configuration.py`?
adam commented 2025-12-29 20:47:13 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Feb 15, 2024):

This feature is essential for the evolution of plugins into more self-contained units, but it also requires a change to the plugin API that we cannot introduce at a micro-version boundary (3.7.2 -> 3.7.3). The soonest our semantic versioning contract would permit it is v4.0.

In the meantime, we can consider alternative approaches that don't involve changes to the plugin API.

@jeffgdotorg commented on GitHub (Feb 15, 2024): This feature is essential for the evolution of plugins into more self-contained units, but it also requires a change to the plugin API that we cannot introduce at a micro-version boundary (3.7.2 -> 3.7.3). The soonest our semantic versioning contract would permit it is v4.0. In the meantime, we can consider alternative approaches that don't involve changes to the plugin API.
adam commented 2025-12-29 20:47:14 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Apr 4, 2024):

Getting this issue out ot triage jail. We should revisit once the dust has settled from 4.0b1 and consider whether to take on the full implementation in v4.1, or look for an alternative approach that can be done within an existing release train without violating the plugin API's semver.

@jeffgdotorg commented on GitHub (Apr 4, 2024): Getting this issue out ot triage jail. We should revisit once the dust has settled from 4.0b1 and consider whether to take on the full implementation in v4.1, or look for an alternative approach that can be done within an existing release train without violating the plugin API's semver.
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 complexity: medium status: accepted topic: plugins 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#9221
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?