docs: document reserved dependsOn/condition parameter names for target job/stage - #2190
Closed
github-actions[bot] wants to merge 1 commit into
Closed
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…t job/stage Front matter parameters named dependsOn or condition on target: job or target: stage collide with the compiler's auto-injected template parameters and fail compilation, but this was undocumented in both docs/targets.md and docs/parameters.md. Add the compile-time error behavior to both pages, cross-linked. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
This was referenced Sep 19, 2026
Collaborator
|
Integrated into #2238 and validated there. Closing this source PR as superseded by the aggregate. |
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.
Agent Documentation Update
Findings
build_parameters()(src/compile/common.rs) auto-injectsdependsOnandconditiontemplate parameters fortarget: job/target: stage, andagentic_pipeline.rs::build_parametersrejects (compile-time error) any user-defined front-matterparameters:entry with either reserved name. Neitherdocs/targets.mdnordocs/parameters.mddocumented this collision/error, only the successful auto-injection behavior.docs/targets.md,docs/parameters.mdApplied Fixes
target: job"Notes" section indocs/targets.mdstatingdependsOn/conditionare reserved parameter names and reusing either in front-matterparameters:is a compile-time error.target: stage"Notes" section indocs/targets.md.target: job/target: stage" subsection todocs/parameters.md, cross-linked todocs/targets.md.Notes
Verified against
src/compile/common.rs::build_parameters(auto-injection ofdependsOn/conditionfor template targets) andsrc/compile/agentic_pipeline.rs::build_parameters(theis_template_targetderivation forCompileTarget::Job | CompileTarget::Stage, and theanyhow::bail!reserved-name check). Confirmed the check applies identically to bothjobandstagetargets.Checked open PRs first via
search_pull_requestsfor overlap — found ~15 open PRs already targeting the well-knowncontainer_runtime.rs-missing-from-AGENTS.md gap and several other known drift items (network ecosystems, ir.md, ado-script.md, azure-cli smoke links, export-bash-scripts flag, prompts permissions-required, sample-agent), so this run targeted a distinct, previously unaddressed gap instead.Created by the agent-documentation maintainer workflow.