feat(workflow): dry-run preview — resolve tokens and show the step plan without executing hooks
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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分
- マージ済み PR(30日)
- 55
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信
falbany/ProFiles の issue をすべて見る
似ている 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 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信