feat(workflow): dry-run preview — resolve tokens and show the step plan without executing hooks

Abierto
#114 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
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python, yaml

Línea de trabajo

Start with src/profiles/core/environment/workflow.py and read _substitute_variables to understand the existing token resolution, then check the workflow exports in src/profiles/core/__init__.py. The proposal also involves the preview route in src/profiles/server/routes/workflow.py, WorkflowRunnerModal.tsx, and both hooks guides. Done means a resolved, read-only preview reports condition outcomes without executing hooks; the issue names no tests to run.

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

Descripción

enhancement

Problem

Authoring workflow hooks today means editing the .profiles YAML, saving, launching a real file, and watching the commands actually run. Every iteration has side effects: files get moved/archived, commands execute, launches happen. A user tweaking a phase: post archive step, or checking whether {{file}}/{{output}} resolve as expected in an ask: prompt, has no way to see the resolved plan without performing the launch. This makes hook authoring the highest-friction part of the workflow feature — debugging requires real files and real executions.

Evidence

  • Token substitution is a private helper with no resolve-only entry point on the core surface: _substitute_variables at src/profiles/core/environment/workflow.py:660. src/profiles/core/__init__.py exports run_hooks_for_file/parse_hook_entries but nothing that renders a step without executing it.
  • Server workflow routes are execution-only: start/get/respond/abort (src/profiles/server/routes/workflow.py:397-643). No preview/dry-run route.
  • The web runner (src/profiles/web/src/components/WorkflowRunnerModal.tsx) can only show steps as they actually execute.
  • docs/hooks-guide.en.md / hooks-guide.fr.md document the token grammar but offer no way to check a substitution result before a real launch.

Proposed approach

  • Core (pure, UI-free): a preview_workflow(steps, context) -> list[PreviewedStep] function in profiles.core.environment.workflow next to _substitute_variables, reusing the same substitution logic (including the quote-aware command path). {{output}} renders as a labelled placeholder since nothing executes; if: conditions are evaluated and reported as true/false/skip. Export from profiles.core.
  • Server: POST /api/workflow/preview taking a file path, with an optional inline steps override so the YAML config editor (issue #95) can preview a draft before saving it.
  • Web: a read-only "Preview" view — either a tab in WorkflowRunnerModal or a standalone modal listing each step with phase, resolved command/message, and condition outcome. No run button.
  • Docs: hooks-guide (en + fr) section.
  • Scope M. No breaking change — pure addition.

Alternatives considered

  1. Cancel before the first command in a real run — still spawns processes, races the user, and can't preview an unsaved draft; doesn't help authoring.
  2. CLI-only profiles --preview-hooks <file> — useful but misses the web-first audience; the core function proposed above can back a CLI flag later at near-zero cost.

Proposed during automated enhancement scan 2026-11-04

Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
4 h 46 min
PR fusionados (30 d)
55

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 falbany/ProFiles

Todos los issues de falbany/ProFiles

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.