docs: Add fork support reference page#18537
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot move guide to the reference section (bottom) |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Removed compatibility table and known limitations for fork support.
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation on how GitHub Agentic Workflows behaves in forked repositories, addressing a gap in the existing documentation.
Changes:
- New reference documentation page explaining two fork scenarios: running workflows inside a fork (not supported, jobs skip) and handling inbound PRs from forks (blocked by default, configurable via
forks:field) - Sidebar navigation updated to include the new "Fork Support" reference page
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/src/content/docs/reference/fork-support.md | New reference page documenting fork behavior, including automatic job skipping in forks and forks: frontmatter configuration for trusted fork PRs |
| docs/astro.config.mjs | Adds "Fork Support" entry to Reference section sidebar navigation |
Comments suppressed due to low confidence (1)
docs/src/content/docs/reference/fork-support.md:23
- The note suggests that forking a repository will allow workflows to run because "the workflows will then run in your copy of the repository, which is not a fork from GitHub Actions' perspective." However, this statement may be misleading.
When you fork a repository on GitHub and then fork it again to your own account, GitHub still considers it a fork (the github.event.repository.fork property will be true). The workflows will still be skipped.
The intended meaning appears to be that if you want to use agentic workflows in your own independent project, you should copy the implementation rather than using GitHub's fork feature. Consider clarifying this to avoid confusion, for example: "To run agentic workflows in your own repository, create an independent repository (not a GitHub fork) and configure your own secrets."
> [!NOTE]
> To run agentic workflows in your own repository, fork the upstream repo and configure your own secrets — the workflows will then run in your copy of the repository, which is not a fork from GitHub Actions' perspective.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No documentation existed explaining how gh-aw behaves in forked repositories. Per the actual implementation, running workflows inside a fork is not supported — all jobs skip via the
!github.event.repository.forkcondition injected at compile time.Changes
docs/src/content/docs/reference/fork-support.md(new): Covers two distinct fork scenarios:forks:frontmatter to allow trusted forks with glob patterns ("owner/*","owner/repo","*")docs/astro.config.mjs: Adds "Fork Support" entry at the bottom of the Reference sidebar section--- on: pull_request: types: [opened, synchronize] forks: - "trusted-org/*" - "partner/specific-fork" ---Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.