Skip to content

Fix invalid YAML example in Job Outputs docs - #56977

Merged
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-fix-invalid-yaml
Aug 29, 2026
Merged

Fix invalid YAML example in Job Outputs docs#56977
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-fix-invalid-yaml

Conversation

Copilot AI commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

The Job Outputs reference example mixed a workflow YAML block with markdown prompt text in the same fenced code block, which produced invalid YAML and misrepresented how workflow files are structured.

  • Corrected the example by separating the workflow YAML from the prompt body into distinct fenced blocks.
  • Kept the YAML example limited to the jobs definition and job outputs.
  • Added a dedicated markdown example for the prompt text that references ${{ needs.release.outputs.version }}.
jobs:
  release:
    outputs:
      release_id: ${{ steps.get_release.outputs.release_id }}
      version: ${{ steps.get_release.outputs.version }}
    steps:
      - id: get_release
        run: echo "version=${{ github.event.release.tag_name }}" >> $GITHUB_OUTPUT
Generate highlights for release ${{ needs.release.outputs.version }}.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix invalid YAML in Job Outputs example Fix invalid YAML example in Job Outputs docs Aug 29, 2026
Copilot AI requested a review from pelikhan August 29, 2026 21:49
@pelikhan
pelikhan marked this pull request as ready for review August 29, 2026 21:50
Copilot AI balanced review requested due to automatic review settings August 29, 2026 21:50
@pelikhan
pelikhan merged commit 3de2ddc into main Aug 29, 2026
1 check passed
@pelikhan
pelikhan deleted the copilot/deep-report-fix-invalid-yaml branch August 29, 2026 21:50

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 focused documentation change produces valid, clearly separated examples.

Pull request overview

Separates the Job Outputs YAML configuration from its markdown prompt, fixing the invalid mixed-language example.

Changes:

  • Closes the YAML fence before the prompt.
  • Adds a dedicated markdown fence for prompt text.
File summaries
File Description
docs/src/content/docs/reference/steps-jobs.md Corrects Job Outputs example formatting.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Balanced

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

@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.87.10

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.

[deep-report] Fix invalid YAML in Job Outputs example (docs/reference/steps-jobs.md)

3 participants