Skip to content

Document workflow parameters in prompt bodies - #66674

Merged
pelikhan merged 2 commits into
mainfrom
copilot/update-workflow-documentation
Oct 7, 2026
Merged

pelikhan merged 2 commits into
mainfrom
copilot/update-workflow-documentation

Conversation

Copilot AI commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Workflow authors need a clear way to configure values once and have them resolved before the agent receives the prompt. The FAQ now distinguishes GitHub Actions expressions from shell-style placeholders.

  • Dispatch inputs: Shows how to reference a run-time parameter with ${{ inputs.branch }}.
  • Workflow environment: Shows how to reference a configured value with ${{ env.PRODUCT }} and clarifies that ${PRODUCT} is not expanded in the prompt body.
---
on:
  workflow_dispatch:
    inputs:
      branch:
        type: string
        default: main
env:
  PRODUCT: Contoso
---

Build a report for ${{ env.PRODUCT }} on branch ${{ inputs.branch }}.

Copilot AI linked an issue Oct 7, 2026 that may be closed by this pull request
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve workflow body parameter configuration Document workflow parameters in prompt bodies Oct 7, 2026
Copilot AI requested a review from pelikhan October 7, 2026 20:04
@pelikhan
pelikhan marked this pull request as ready for review October 7, 2026 20:17
Copilot AI balanced review requested due to automatic review settings October 7, 2026 20:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation accurately reflects the compiler’s runtime prompt interpolation behavior.

0 open findings

What changed in this PR

Documents deterministic prompt parameter substitution using GitHub Actions expressions.

Changes:

  • Adds examples for dispatch inputs and workflow-level environment variables.
  • Clarifies that shell-style placeholders are not expanded.
File Description
docs/​src/​content/​docs/​reference/​faq.md Adds workflow prompt parameter guidance and example syntax.

🧠 Review effort: Balanced


💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

@pelikhan
pelikhan merged commit cee9ce1 into main Oct 7, 2026
7 checks passed
@pelikhan
pelikhan deleted the copilot/update-workflow-documentation branch October 7, 2026 22:03
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.91.6

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.

Workflow body parameters?

3 participants