Skip to content

[docs] Self-healing documentation fixes: document tools.github.mode gh-proxy - 2026-04-22#27839

Merged
pelikhan merged 1 commit intomainfrom
docs/doc-healer-gh-proxy-mode-2026-04-22-d683b4623199a31e
Apr 22, 2026
Merged

[docs] Self-healing documentation fixes: document tools.github.mode gh-proxy - 2026-04-22#27839
pelikhan merged 1 commit intomainfrom
docs/doc-healer-gh-proxy-mode-2026-04-22-d683b4623199a31e

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Apr 22, 2026

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

Gaps Fixed

  • Commit Refactor cli-proxy feature into tools.github.mode (gh-proxy) with codemod migration #27707 (Refactor cli-proxy feature into tools.github.mode (gh-proxy) with codemod migration, merged 2026-04-22T01:11Z) introduced tools.github.mode: gh-proxy as the preferred alternative to the legacy features.cli-proxy flag, but the reference/github-tools.md reference page was not updated.

    The "GitHub Tools Remote Mode" section only documented local and remote modes. gh-proxy mode (and its alias cli) were absent. Users who follow the reference to configure GitHub Tools access would have no way of discovering this new preferred mode.

Root Cause

DDUw did not produce a docs PR for today's (2026-04-22) changes. Commit #27707 landed at 01:11 UTC — before the DDUw's 10:00 UTC run window — but the DDUw run appears to have been blocked by protected-file changes (see #27826 which merged the fix for this at 13:26 UTC). As a result, the gh-proxy mode change was not captured in any [docs] PR.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

  • Protected-file fallback: The DDUw was blocking on protected-file changes rather than falling back to a docs-only run. PR Configure Daily Documentation Updater to fall back to review issues on protected-file changes #27826 adds this fallback. Once merged and deployed, the DDUw should handle this class of failure gracefully.
  • Mode field coverage: The DDUw's feature-documentation step should cross-reference tools.github.mode values against the github-tools.md reference page when it detects changes to pkg/workflow/mcp_github_config.go. Adding a scan step for mode/option enum additions in mcp_github_config.go would catch this class of gap.

Related Issues

References:

Generated by Daily Documentation Healer · ● 825.7K ·

  • expires on Apr 25, 2026, 1:33 PM UTC

Smoke CI scheduled run observed this PR. Run URL: https://github.com/github/gh-aw/actions/runs/24781286728

Generated by Smoke CI · ● 310.3K ·

The tools.github.mode field now accepts three values: local (default),
remote, and gh-proxy. The gh-proxy mode was introduced in #27707 as the
preferred alternative to the legacy features.cli-proxy flag, but was
not yet reflected in the github-tools.md reference page.

Expands the "GitHub Tools Remote Mode" section into "GitHub Tools Access
Modes" with a summary table and prose for each of the three modes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Apr 22, 2026
@pelikhan pelikhan marked this pull request as ready for review April 22, 2026 13:40
Copilot AI review requested due to automatic review settings April 22, 2026 13:40
@pelikhan pelikhan merged commit c8ac4a5 into main Apr 22, 2026
3 checks passed
@pelikhan pelikhan deleted the docs/doc-healer-gh-proxy-mode-2026-04-22-d683b4623199a31e branch April 22, 2026 13:40
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

Updates the GitHub Tools reference documentation to include the newly introduced tools.github.mode: gh-proxy access mode.

Changes:

  • Renames the “GitHub Tools Remote Mode” section to “GitHub Tools Access Modes”.
  • Documents tools.github.mode options in a table, adding gh-proxy mode and describing its behavior and usage.
  • Adds a dedicated configuration example and explanation for gh-proxy mode.
Show a summary per file
File Description
docs/src/content/docs/reference/github-tools.md Documents GitHub Tools access modes, including the new gh-proxy mode and example configuration.

Copilot's findings

Tip

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

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

@@ -94,17 +94,33 @@ The `repos` field was renamed to `allowed-repos` to better reflect its purpose.

By default, the GitHub Tools can read from the current repository and all public repositories (if permitted by the network firewall). To read from other private repositories, you must configure additional authentication. See [Cross-Repository Operations](/gh-aw/reference/cross-repository/) for details and examples.

Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

This section heading was renamed to “GitHub Tools Access Modes”, but later in this page there’s still a link to #github-tools-remote-mode (under “Additional Authentication…”). That anchor will no longer exist; update the link/label to point at the new #github-tools-access-modes section (or restore a matching heading ID).

Suggested change
<a id="github-tools-remote-mode"></a>

Copilot uses AI. Check for mistakes.
Comment on lines +99 to +103
The `tools.github.mode` field controls how the agent accesses GitHub. Three values are supported:

| Mode | Transport | Notes |
|------|-----------|-------|
| `local` (default) | Docker-based GitHub MCP Server inside the Actions VM | No extra authentication required |
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

The text says only three tools.github.mode values are supported, but the code also accepts the legacy alias cli for gh-proxy (see pkg/workflow/mcp_github_config.go, which maps cli -> gh-proxy). Please document cli as a deprecated alias (e.g., in the table or in the gh-proxy section) so existing workflows are covered.

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

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants