feat(workflow): dry-run preview — resolve tokens and show the step plan without executing hooks
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
- Ambito
- api, backend, documentation, frontend
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
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_variablesatsrc/profiles/core/environment/workflow.py:660.src/profiles/core/__init__.pyexportsrun_hooks_for_file/parse_hook_entriesbut 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.mddocument 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 inprofiles.core.environment.workflownext 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 fromprofiles.core. - Server:
POST /api/workflow/previewtaking a file path, with an optional inlinestepsoverride so the YAML config editor (issue #95) can preview a draft before saving it. - Web: a read-only "Preview" view — either a tab in
WorkflowRunnerModalor 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
- 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.
- 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
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di falbany/ProFiles
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
falbany/ProFiles#187 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Web UI: config handoff from a second launch leaves the open YAML editor showing stale contentApertabug frontend
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
bug frontend
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
bug frontend
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di falbany/ProFiles
Issue simili
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
aws-samples/sample-spec-driven-presentation-maker#648 ·
I maintainer di solito rispondono entro 1 giorno
-
firestore: enable live window.yaml pipeline system tests once add_window_fields is in productionAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 64/100
googleapis/google-cloud-python#19115 ·
I maintainer di solito rispondono entro 2 giorni
-
CRS WKT default to WKT2Apertaenhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno