Skip to content

docs: fix conclusion job token reference and create-prompt field list - #1690

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-conclusion-token-and-prompt-fields-ec2598996017076c
Draft

docs: fix conclusion job token reference and create-prompt field list#1690
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-conclusion-token-and-prompt-fields-ec2598996017076c

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Agent Documentation Update

Findings

Area Issue File(s)
Accuracy docs/conclusion.md line 94 said the Conclusion job uses only SYSTEM_ACCESSTOKEN, but fix #1689 added SC_WRITE_TOKEN acquisition to the Conclusion job when permissions.write is configured. This contradicted lines 113–118 on the same page and the actual compiled output. docs/conclusion.md
Accuracy (prompt) prompts/create-ado-agentic-workflow.md optional fields list was missing post-steps, execution-context, variable-groups, and env — all valid FrontMatter fields verified in src/compile/types.rs. Agents authoring new workflows would be unaware these keys exist. prompts/create-ado-agentic-workflow.md

Applied Fixes

  • docs/conclusion.md line 94: updated "using SYSTEM_ACCESSTOKEN" → "using SYSTEM_ACCESSTOKEN (or SC_WRITE_TOKEN when a write service connection is configured)" — consistent with lines 113–118 and the build_conclusion_job code in src/compile/agentic_pipeline.rs
  • prompts/create-ado-agentic-workflow.md: added post-steps, execution-context, variable-groups, and env to the optional front-matter fields list

Notes

  • Token behavior verified against src/compile/agentic_pipeline.rs::build_conclusion_job (lines 1802–1803), which calls push_raw_yaml_if_nonempty(&mut steps, &cfg.acquire_write_token) — the same acquire-token step used by SafeOutputs.
  • Missing fields verified against pub struct FrontMatter in src/compile/types.rs (lines 1048–1178).

Created by the agent-documentation maintainer workflow.

Generated by Agent Documentation Maintainer · 93.2 AIC · ⌖ 12 AIC · ⊞ 8.7K ·

- docs/conclusion.md: line 94 said only SYSTEM_ACCESSTOKEN but after
  fix #1689 the Conclusion job also acquires SC_WRITE_TOKEN when
  permissions.write is configured; make it consistent with lines 113-118
- prompts/create-ado-agentic-workflow.md: add execution-context,
  variable-groups, post-steps, and env to the optional front-matter
  fields list so agents know these keys exist when authoring workflows

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@azure-pipelines

Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants