docs: add parameters step to workflow creation prompt#491
Merged
jamesadevine merged 1 commit intoMay 10, 2026
Merged
Conversation
The `parameters:` front matter field was implemented but absent from the 14-step workflow creation guide in prompts/create-ado-agentic-workflow.md. Agents reading that prompt had no guidance on declaring ADO runtime parameters (surfaced in the queue UI) or the auto-injected `clearMemory` parameter that cache-memory emits. Add Step 15 covering: - When to use `parameters:` - Full field reference table (name, displayName, type, default, values) - Example with string (dropdown) and boolean parameters - Note about the auto-injected `clearMemory` parameter Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Freshness Audit
This audit compared all documentation files against the actual codebase (
src/,docs/,AGENTS.md,README.md,prompts/).Findings
parameters:front matter field was absent from all 14 stepsprompts/create-ado-agentic-workflow.mdAll other documentation areas passed the audit:
AGENTS.md) — every source file listed is present; no new files are missing from the treedocs/cli.md,README.md) — matchmain.rsCommandsenum exactly (all 7 subcommands, all flags)docs/front-matter.md,README.md) — matchFrontMatterstruct intypes.rs;env:correctly noted as reserved/unimplementeddocs/template-markers.md) — all 44 markers inbase.yml/1es-base.ymlare documented; removed markers (\{\{ mcp_client_config }},\{\{ copilot_version }}) documented as removeddocs/safe-outputs.md,README.md) — all 23 tools insrc/safeoutputs/are documenteddocs/network.md) — every entry inCORE_ALLOWED_HOSTSis in the docs tableDEFAULT_COPILOT_MODEL = "claude-opus-4.7"matches all docs and the prompt model table[1, 2, 3, 4, 6, 8, 12]matchfuzzy_schedule.rsDetails
prompts/create-ado-agentic-workflow.mdis the primary guide AI agents use when generating new workflow files. Its 14 steps cover all front matter fields exceptparameters:. Theparameters:field is fully implemented inFrontMatter(src/compile/types.rs:658) and emits a top-levelparameters:ADO YAML block. The compiler also auto-injects aclearMemoryparameter whentools.cache-memoryis enabled (src/compile/common.rs:430-437).Without guidance in the prompt, agents creating workflows won't know to suggest
parameters:even when context makes it appropriate (e.g., when the user wants a boolean flag to control agent behavior at queue time).Applied Fixes
prompts/create-ado-agentic-workflow.mdcovering: purpose, YAML example with string dropdown and boolean parameters, full field reference table, and a note about the auto-injectedclearMemoryparameter.This pull request was created by the automated documentation freshness check.