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

Aperta
#114 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python, yaml

Direzione di ricerca

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.

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

Descrizione

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

Lingua principale
Python
Stelle
1
Fork
1
Merge medio
4h 46m
PR unite (30g)
55

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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

Tutte le issue di falbany/ProFiles

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.