docs: create missing /reference/auth-projects/ page#21280
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [deep-report] Fix docs navigation gap and onboarding breakage around /reference/auth-projects
docs: create missing /reference/auth-projects/ page
Mar 16, 2026
pelikhan
approved these changes
Mar 16, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds the missing reference page for “Authentication (Projects)” to fix a sidebar link that currently 404s, documenting how to authenticate GitHub Projects read/write operations in gh-aw.
Changes:
- Added
docs/src/content/docs/reference/auth-projects.mdxwith guidance on whyGITHUB_TOKENis insufficient for Projects. - Documented PAT (classic + fine-grained) and GitHub App token approaches for Projects access.
- Provided recommended secret/token layout and workflow configuration examples, plus related links.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
|
||
| Reference each token in the workflow where it is needed: | ||
|
|
||
| ```aw wrap |
| github-token: ${{ secrets.GH_AW_WRITE_PROJECT_TOKEN }} | ||
| ``` | ||
|
|
||
| The magic secret `GH_AW_GITHUB_MCP_SERVER_TOKEN` is recognized by GitHub Agentic Workflows and does not need to be explicitly referenced in your workflow — if it is present in the repository, it is used automatically for all GitHub tools toolsets, including `projects`. |
| - **Resource owner**: the organization that owns the project | ||
| - **Repository access**: the repositories that will run the workflow | ||
| - **Repository permissions**: `Contents: Read`, and optionally `Issues: Read` / `Pull requests: Read` | ||
| - **Organization permissions**: `Projects: Read and write` |
Comment on lines
+49
to
+52
| ```bash wrap | ||
| gh aw secrets set GH_AW_READ_PROJECT_TOKEN --value "<read-token>" | ||
| gh aw secrets set GH_AW_WRITE_PROJECT_TOKEN --value "<write-token>" | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The sidebar nav entry
Authentication (Projects)pointed to/reference/auth-projects/but no file existed, producing a 404 for any user who clicked it.Changes
docs/src/content/docs/reference/auth-projects.mdx— reference page covering GitHub Projects authentication:GITHUB_TOKENis insufficient (repo-scoped; Projects API sits outside that scope)project+ optionalreposcopes)GH_AW_READ_PROJECT_TOKEN/GH_AW_WRITE_PROJECT_TOKEN) with a minimal workflow snippetGH_AW_GITHUB_MCP_SERVER_TOKENnoteauth,github-tools,safe-outputs, andproject-ops📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.