Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Clarify change logging and object-change events for runs without a request

Aperta Adatta ai principianti
  • Qualcosa non va?
#80 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Leggi la sezione “Attribution without a synthetic request” in docs/development/netbox-internals.md, quindi aggiorna “Scripts as event sources” in docs/administration/event-rules.md e “Commit and dry run” in docs/user-guide/execution.md. Chiarisci che i record e gli eventi automatici di modifica degli oggetti richiedono un contesto di richiesta, mentre gli eventi accodati esplicitamente vengono svuotati separatamente. Mantieni distinti i log di Script e gli eventi del ciclo di vita di Job.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

app: scripts status: backlog type: documentation
Change Type

Correction

Proposed Changes

Correct the descriptions of committed runs in:

  • docs/administration/event-rules.md, “Scripts as event sources”
  • docs/user-guide/execution.md, “Commit and dry run”

The guides imply that every successful committed run records object changes and publishes their events. NetBox's automatic change logging and object-change events require a request context.

Scripts started by Event Rules for job events, such as Job completed, run without a request. Their database changes are kept when the run succeeds, but NetBox does not automatically create ObjectChange records or queue object-change events for them.

For these runs, run_script() enters event_tracking(None), and NetBox's handle_changed_object() returns before recording or queuing the change. The “Attribution without a synthetic request” section in docs/development/netbox-internals.md already describes this dependency.

Please clarify the request requirement in both guides. Distinguish automatic object-change collection from flushing explicitly queued events, and keep Script logs and Job lifecycle events separate.

This is a documentation correction. Providing an attribution context for runs without a request would be a separate behavior change.

Lingua principale
Python
Stelle
8
Fork
0
Merge medio
11h 35m
PR unite (30g)
20

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di netbox-community/netbox-scripts

Tutte le issue di netbox-community/netbox-scripts

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.