feat(workflow): dry-run preview — resolve tokens and show the step plan without executing hooks
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- python, yaml
- 领域
- api, backend, documentation, frontend
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- Python
- 星标
- 1
- 派生
- 1
- 平均合并
- 4 小时 46 分钟
- 30 天内合并 PR
- 55
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
falbany/ProFiles 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
falbany/ProFiles#187 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug frontend
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug frontend
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
bug frontend
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
相似的 Issue
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 86/100
aws-samples/sample-spec-driven-presentation-maker#648 ·
维护者通常 1 天内回复
-
firestore: enable live window.yaml pipeline system tests once add_window_fields is in production未关闭
难度 1/5 1 小时以内 新手友好度 64/100
googleapis/google-cloud-python#19115 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 80/100
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
Feyisara2108/stellargive#1377 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复