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

Establish a GitHub repository template for NetBox plugins #3869

New Issue
Closed
opened 2025-12-29 18:31:41 +01:00 by adam · 5 comments
adam commented 2025-12-29 18:31:41 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jul 17, 2020).

Proposed Changes

Create a GitHub repository template for NetBox plugins. This template should include boilerplate common to all plugins: setup.py, README, a PluginConfig, etc.

Justification

Providing a repo template allows users to clone a repo directly from the template and avoid having to craft the provided boilerplate by hand.

Originally created by @jeremystretch on GitHub (Jul 17, 2020). ### Proposed Changes Create a [GitHub repository template](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/) for NetBox plugins. This template should include boilerplate common to all plugins: `setup.py`, `README`, a `PluginConfig`, etc. ### Justification Providing a repo template allows users to clone a repo directly from the template and avoid having to craft the provided boilerplate by hand.
adam closed this issue 2025-12-29 18:31:41 +01:00
adam commented 2025-12-29 18:31:41 +01:00
Author
Owner
Copy Link

@mirceaulinic commented on GitHub (Jul 21, 2020):

Just an idea, not sure if you like this approach or the project, but I've used this pattern to great effect: https://cookiecutter.readthedocs.io/. HTH!

@mirceaulinic commented on GitHub (Jul 21, 2020): Just an idea, not sure if you like this approach or the project, but I've used this pattern to great effect: https://cookiecutter.readthedocs.io/. HTH!
adam commented 2025-12-29 18:31:41 +01:00
Author
Owner
Copy Link

@bcohee commented on GitHub (Jul 22, 2020):

It would be nice to have a centralized list where authors could submit their plugins, ideally within the github/netbox-community project

@bcohee commented on GitHub (Jul 22, 2020): It would be nice to have a centralized list where authors could submit their plugins, ideally within the github/netbox-community project
adam commented 2025-12-29 18:31:41 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 22, 2020):

@bcohee There is a list here: https://github.com/netbox-community/netbox/wiki/Plugins

We intend to invite the authors of plugins which become mature and popular to join the netbox-community GitHub organization, though I don't think anyone's put together a firm list of qualifications yet.

@jeremystretch commented on GitHub (Jul 22, 2020): @bcohee There is a list here: https://github.com/netbox-community/netbox/wiki/Plugins We intend to invite the authors of plugins which become mature and popular to join the `netbox-community` GitHub organization, though I don't think anyone's put together a firm list of qualifications yet.
adam commented 2025-12-29 18:31:42 +01:00
Author
Owner
Copy Link

@lampwins commented on GitHub (Jul 22, 2020):

@ryanmerolle also managed to get netbox-plugin to be registered as an official github topic, so if authors add that to their repo's topic list, it will show up when searching in github.

@lampwins commented on GitHub (Jul 22, 2020): @ryanmerolle also managed to get `netbox-plugin` to be registered as an official github topic, so if authors add that to their repo's topic list, it will show up when searching in github.
adam commented 2025-12-29 18:31:42 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 17, 2020):

Going to close this out as it doesn't apply to NetBox itself. Someone else is welcome to take on the task if interested, though by this point there are probably enough plugins in the wild to serve as a reference.

@jeremystretch commented on GitHub (Dec 17, 2020): Going to close this out as it doesn't apply to NetBox itself. Someone else is welcome to take on the task if interested, though by this point there are probably enough plugins in the wild to serve as a reference.
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
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#3869
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?