Skip to content

docs: clarify directory restrictions for reusable agentic workflows - #71451

Merged
pelikhan merged 2 commits into
mainfrom
copilot/reuse-workflows-outside-github
Oct 23, 2026
Merged

pelikhan merged 2 commits into
mainfrom
copilot/reuse-workflows-outside-github

Conversation

Copilot AI commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Central workflow repositories may want Markdown, compiled YAML, and documentation colocated outside .github/workflows/. GitHub Actions requires callable YAML directly in that directory; gh-aw cannot override this restriction.

  • Platform constraint: Add an FAQ distinguishing compilation location from workflow_call eligibility.
  • Centralized reuse: Show callers referencing the central .lock.yml without copying implementation:
    jobs:
      review:
        uses: my-org/agentic-workflows/.github/workflows/review.lock.yml@v1
        secrets: inherit
  • Organization and security: Explain imports for shared components, immutable SHA pinning, caller access, permissions, and credential requirements.
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Investigate reusing workflows outside .github/workflows/ Oct 23, 2026
Copilot AI requested a review from pelikhan October 23, 2026 14:29
@pelikhan
pelikhan marked this pull request as ready for review October 23, 2026 14:41
Copilot AI max review requested due to automatic review settings October 23, 2026 14:41
@pelikhan
pelikhan merged commit ddaf87d into main Oct 23, 2026
3 checks passed
@pelikhan
pelikhan deleted the copilot/reuse-workflows-outside-github branch October 23, 2026 14:41

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.

🟡 Changes recommended

The documented cross-repository setup omits requirements needed for successful activation.

2 open issues
What changed in this PR

Clarifies where centrally maintained gh-aw workflows must live to support workflow_call, addressing #71086 without requiring implementation copies in caller repositories.

Changes:

  • Distinguishes compilation location from GitHub Actions’ reusable-workflow directory requirements.
  • Adds a central .lock.yml caller example.
  • Explains immutable references, caller access, credentials, and shared imports.
File Description
docs/​src/​content/​docs/​reference/​faq.md Adds an FAQ covering reusable-workflow placement and centralized reuse.

Review effort: Max

secrets: inherit
```

Use a full commit SHA instead of `v1` for an immutable reference. The caller must have access to the reusable workflow and provide the required permissions and engine credentials; `secrets: inherit` is available within the same organization or enterprise.

Use a full commit SHA instead of `v1` for an immutable reference. The caller must have access to the reusable workflow and provide the required permissions and engine credentials; `secrets: inherit` is available within the same organization or enterprise.

For a repository organized by action, keep documentation and shared components separately, but retain the callable entry point in `.github/workflows/`. [Imports](/gh-aw/reference/imports/) can separate shared configuration and prompt content from entry-point Markdown; they are not independently callable workflows.
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.93.3

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

Labels

None yet

3 participants