Skip to content

Reconcile AGENTS/CONTRIBUTING docs with current config and auth behavior#6018

Merged
lpcox merged 2 commits into
mainfrom
copilot/fix-agents-md-gh-token-issue
May 19, 2026
Merged

Reconcile AGENTS/CONTRIBUTING docs with current config and auth behavior#6018
lpcox merged 2 commits into
mainfrom
copilot/fix-agents-md-gh-token-issue

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 19, 2026

Nightly docs reconciliation flagged drift between AGENTS.md/CONTRIBUTING.md and the implemented behavior. The main gaps were token fallback priority clarity and missing quick-reference mentions for supported config fields and make help.

  • Auth token priority alignment (AGENTS.md)

    • Clarified GITHUB_PERSONAL_ACCESS_TOKEN as the third-priority fallback.
    • Added missing GH_TOKEN as the lowest-priority fallback (GitHub CLI-provided token path).
  • JSON stdin/TOML quick-reference completeness (AGENTS.md)

    • Added explicit mention of optional JSON stdin fields:
      • stdio: entrypoint, entrypointArgs, mounts
      • http: connectTimeout
    • Added direct pointer to full references for broader field coverage:
      • docs/CONFIGURATION.md
      • config.example.toml
      • includes gateway/top-level fields like keepalive_interval, sequential_launch, guards_mode.
  • Make target discoverability (CONTRIBUTING.md)

    • Added make help to the documented command set so contributors can enumerate available targets directly.
- `GITHUB_PERSONAL_ACCESS_TOKEN` - Third-priority GitHub auth fallback
- `GH_TOKEN` - Lowest-priority GitHub auth fallback (set by GitHub CLI)
...
- **Note**: In JSON stdin format, stdio servers also support optional `entrypoint`, `entrypointArgs`, and `mounts` fields; HTTP servers support optional `connectTimeout`

Copilot AI linked an issue May 19, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix missing GH_TOKEN in AGENTS.md environment variables Reconcile AGENTS/CONTRIBUTING docs with current config and auth behavior May 19, 2026
Copilot AI requested a review from lpcox May 19, 2026 15:33
Copilot finished work on behalf of lpcox May 19, 2026 15:33
@lpcox lpcox marked this pull request as ready for review May 19, 2026 21:24
Copilot AI review requested due to automatic review settings May 19, 2026 21:24
@lpcox lpcox merged commit 16c2c47 into main May 19, 2026
15 of 16 checks passed
@lpcox lpcox deleted the copilot/fix-agents-md-gh-token-issue branch May 19, 2026 21:25
Copy link
Copy Markdown
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

Reconciles AGENTS.md and CONTRIBUTING.md with actual behavior surfaced by the nightly docs reconciliation: clarifies the GitHub token fallback priority, fills in missing JSON-stdin/TOML quick-reference fields, and adds make help to the contributor command list.

Changes:

  • Clarify GITHUB_PERSONAL_ACCESS_TOKEN as third-priority and add GH_TOKEN as lowest-priority fallback, matching internal/envutil/github.go.
  • Note additional optional JSON-stdin fields (entrypoint, entrypointArgs, mounts, connectTimeout) and point to docs/CONFIGURATION.md / config.example.toml for full coverage.
  • Document make help in CONTRIBUTING.md.
Show a summary per file
File Description
AGENTS.md Aligns token priority docs with LookupGitHubToken and broadens JSON/TOML field references.
CONTRIBUTING.md Adds make help to the documented build/dev command set.

Copilot's findings

Tip

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

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

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.

📚 Documentation Reconciliation Report - 2026-05-18

3 participants