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

Require 'commit' argument in custom script run() method #3934

New Issue
Closed
opened 2025-12-29 18:32:09 +01:00 by adam · 0 comments
adam commented 2025-12-29 18:32:09 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Aug 3, 2020).

Proposed Changes

#4262 introduced support for an optional commit argument in a custom script's run() method. This issue serves to document the deprecation of this as an optional argument: Beginning with v2.10, a custom script's run() method must accept a commit argument.

Justification

Removes superfluous backward-compatibility logic from core. A custom script doesn't necessarily need to do anything with the commit argument; it just needs to accept it when called via run_script().

Originally created by @jeremystretch on GitHub (Aug 3, 2020). ### Proposed Changes #4262 introduced support for an optional `commit` argument in a custom script's `run()` method. This issue serves to document the deprecation of this as an optional argument: Beginning with v2.10, a custom script's `run()` method **must** accept a `commit` argument. ### Justification Removes superfluous backward-compatibility logic from core. A custom script doesn't necessarily need to _do_ anything with the `commit` argument; it just needs to accept it when called via `run_script()`.
adam added the status: acceptedtype: deprecation labels 2025-12-29 18:32:09 +01:00
adam closed this issue 2025-12-29 18:32:10 +01:00
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 status: accepted type: deprecation
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#3934
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?