Skip to content

Comments

docs: fix steps: placement in Deterministic Multi-Repo Workflows example#18143

Merged
pelikhan merged 3 commits intomainfrom
copilot/fix-deterministic-multi-repo-workflows
Feb 24, 2026
Merged

docs: fix steps: placement in Deterministic Multi-Repo Workflows example#18143
pelikhan merged 3 commits intomainfrom
copilot/fix-deterministic-multi-repo-workflows

Conversation

Copy link
Contributor

Copilot AI commented Feb 24, 2026

The "Deterministic Multi-Repo Workflows" code example in the MultiRepoOps docs had steps: incorrectly nested under engine:, causing compilation to fail with Unknown property: steps.

Change

  • docs/src/content/docs/patterns/multi-repo-ops.md: Moved steps: from under engine: to a top-level frontmatter key.
# Before (broken)
engine:
  id: claude
  steps:
    - name: Checkout main repo
      ...

# After (correct)
engine:
  id: claude

steps:
  - name: Checkout main repo
    ...
Original prompt

This section details on the original issue you should resolve

<issue_title>Docs: MultiRepoOps 'Deterministic Multi-Repo Workflows' example has steps: under engine: which fails compilation</issue_title>
<issue_description>## Page

https://github.github.io/gh-aw/patterns/multi-repo-ops/#deterministic-multi-repo-workflows

Problem

The "Deterministic Multi-Repo Workflows" section shows steps: nested under engine::

engine:
  id: claude
  steps:
    - name: Checkout main repo
      uses: actions/checkout@v5
      ...
    - name: Checkout secondary repo
      uses: actions/checkout@v5
      ...

This does not compile. The compiler rejects steps as an unknown property under /engine:

error: at '/engine' (line 21, column 3): Unknown property: steps

Expected

steps: should be a top-level frontmatter key, not nested under engine::

engine:
  id: claude

steps:
  - name: Checkout main repo
    uses: actions/checkout@v5
    with:
      path: main-repo
  - name: Checkout secondary repo
    uses: actions/checkout@v5
    with:
      repository: org/secondary-repo
      token: ${{ secrets.GH_AW_CROSS_REPO_PAT }}
      path: secondary-repo

Version

gh-aw v0.50.0 (compiler version from lock file)</issue_description>

Comments on the Issue (you are @copilot in this section)


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Copilot AI and others added 2 commits February 24, 2026 13:12
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix compilation error in multi-repo workflows documentation docs: fix steps: placement in Deterministic Multi-Repo Workflows example Feb 24, 2026
@pelikhan pelikhan marked this pull request as ready for review February 24, 2026 13:16
Copilot AI review requested due to automatic review settings February 24, 2026 13:16
@pelikhan pelikhan merged commit f1263e8 into main Feb 24, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/fix-deterministic-multi-repo-workflows branch February 24, 2026 13:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a critical YAML structure error in the MultiRepoOps documentation where steps: was incorrectly nested under engine:, causing compilation to fail with "Unknown property: steps". The fix correctly moves steps: to be a top-level frontmatter field as specified in the schema.

Changes:

  • Corrected YAML structure in the "Deterministic Multi-Repo Workflows" example by moving steps: from under engine: to top-level frontmatter
  • Regenerated smoke-copilot.lock.yml workflow file (includes unrelated infrastructure update)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/src/content/docs/patterns/multi-repo-ops.md Fixed incorrect YAML structure by moving steps: array from nested under engine: to top-level frontmatter position
.github/workflows/smoke-copilot.lock.yml Auto-generated lock file with updated compilation output (includes new MCP configuration cleanup step)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +1864 to +1869
- name: Clear MCP configuration for detection
if: always() && steps.detection_guard.outputs.run_detection == 'true'
run: |
rm -f /tmp/gh-aw/mcp-config/mcp-servers.json
rm -f /home/runner/.copilot/mcp-config.json
rm -f "$GITHUB_WORKSPACE/.gemini/settings.json"
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

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

This auto-generated lock file includes a new step "Clear MCP configuration for detection" that wasn't present before. Since this file is automatically generated from smoke-copilot.md (which doesn't contain this step definition), this change appears to come from updates to the compilation infrastructure itself.

While this may be expected if the compiler was updated, the PR description doesn't mention this change. If this is an intentional infrastructure update that affects all compiled workflows, it would be helpful to note this in the PR description. If this change is unintentional or if only the documentation fix should be included, consider regenerating the lock file without this additional change.

Copilot uses AI. Check for mistakes.
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.

Docs: MultiRepoOps 'Deterministic Multi-Repo Workflows' example has steps: under engine: which fails compilation

2 participants