Skip to content

Allow plugins to declare a release track #17857

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

Closed
natm opened this issue Oct 24, 2024 · 2 comments
Closed

Allow plugins to declare a release track #17857

natm opened this issue Oct 24, 2024 · 2 comments
Assignees
Labels
complexity: low Requires minimal effort to implement status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Milestone

Comments

@natm
Copy link

natm commented Oct 24, 2024

NetBox version

v4.1.4

Feature type

New functionality

Triage priority

I volunteer to perform this work (if approved)

Proposed functionality

When defining a plugin it would be helpful if along with the version, the release track could be optionally declared, for example dev, release, etc.

from netbox.plugins import PluginConfig

class FooBarConfig(PluginConfig):
    name = 'foo_bar'
    verbose_name = 'Foo Bar'
    description = 'An example NetBox plugin'
    version = '0.0.1'
    author = 'Jeremy Stretch'
    author_email = '[email protected]'
    base_url = 'foo-bar'
    release_track = 'release'

config = FooBarConfig

Use case

When installed plugins are listed the track could be displayed along with the version. This could be used to distinguish if a plugin has been installed from a published release or is running from a local development clone.

Database changes

None

External dependencies

None

@natm natm added status: needs triage This issue is awaiting triage by a maintainer type: feature Introduction of new functionality to the application labels Oct 24, 2024
@jeremystretch
Copy link
Member

Makes sense to me. Do we want to go as far as declaring a set of valid values for this attribute, or leave it up to the individual plugins?

@jeremystretch jeremystretch added status: under review Further discussion is needed to determine this issue's scope and/or implementation and removed status: needs triage This issue is awaiting triage by a maintainer labels Oct 25, 2024
@natm
Copy link
Author

natm commented Oct 28, 2024

Makes sense to me. Do we want to go as far as declaring a set of valid values for this attribute, or leave it up to the individual plugins?

Yes it would be nice if the options could be constrained to dev and release with a default of release if the field is not specified.

@jeremystretch jeremystretch added the netbox label Nov 1, 2024 — with Linear
@linear linear bot added the platform label Jan 8, 2025
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation needs milestone Awaiting prioritization for inclusion with a future NetBox release and removed status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Jan 17, 2025
@jeremystretch jeremystretch added this to the v4.3 milestone Jan 24, 2025
@jeremystretch jeremystretch added status: backlog Awaiting selection for work complexity: low Requires minimal effort to implement and removed needs milestone Awaiting prioritization for inclusion with a future NetBox release platform status: accepted This issue has been accepted for implementation netbox labels Jan 24, 2025
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed status: backlog Awaiting selection for work labels Feb 3, 2025
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
complexity: low Requires minimal effort to implement status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

No branches or pull requests

2 participants