Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
#80 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
85/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

Lee la sección “Attribution without a synthetic request” en docs/development/netbox-internals.md y luego actualiza “Scripts as event sources” en docs/administration/event-rules.md y “Commit and dry run” en docs/user-guide/execution.md. Aclara que los registros y eventos automáticos de cambios en objetos requieren un contexto de solicitud, mientras que los eventos encolados explícitamente se procesan por separado. Mantén separados los registros de Script y los eventos del ciclo de vida de Job.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
8
Forks
0
Merge medio
11 h 35 min
PR fusionados (30 d)
20

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de netbox-community/netbox-scripts

Todos los issues de netbox-community/netbox-scripts

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.