Skip to content

[enterprise-docs] Engines reference states an unqualified GHES Copilot api-target #76811

Closed

Description

@github-actions

User task and impact

Question (Credentials and permissions / GHES): On GitHub Enterprise Server with a Copilot engine, which Copilot endpoint do I set, and is that a supported configuration?

Platform: GitHub Enterprise Server (version not verified). The enterprise persona is self-hosted Linux with restricted egress.

Expected answer path: The Engines reference (/gh-aw/reference/engines/, "Enterprise API Endpoint (api-target)") and the GHES prerequisites section in Troubleshooting. Both should agree on the endpoint and on what is and is not supported.

Actual obstacle: The Engines reference states, without qualification, "For GHES Copilot use api.enterprise.githubcopilot.com." The Enterprise configuration reference and the GHES prerequisites section say that GHES endpoint routing does not establish GitHub Agentic Workflows availability on GHES, that GHES combinations remain unconfirmed, and that the endpoint is shown "only if that endpoint is available for your account and deployment; it is not a GHES support promise." A reader who follows the Engines page can conclude GHES Copilot is supported.

Operational consequence: An enterprise admin may approve a GHES rollout on the strength of one unqualified line, then find the Copilot path unsupported or unavailable for the deployment. They may also set the endpoint without the licensing and policy checks the troubleshooting page requires.

Reproduction and evidence

I verified the wording on the published site and in the checked-out source at commit badad12d770b101c1539e954b9a69a862c5b742c. I did not run a workflow against a GHES instance.

Reproduction steps and supporting evidence
  1. Published https://github.github.com/gh-aw/reference/engines/ (opened by direct URL after the walkthrough, not through the sidebar). Under "Enterprise API Endpoint (api-target)", the page text reads: "For GHES Copilot use api.enterprise.githubcopilot.com. See GHE Cloud troubleshooting for data-residency setup."

  2. Source only (not checked on the deployed site): docs/src/content/docs/reference/enterprise-configuration.md line 13 says "Component compatibility is not end-to-end product support" and that GHES "combinations without an explicit owner-confirmed commitment remain unconfirmed." Line 163 links to "Copilot Engine Prerequisites on GHES" for GHES licensing and firewall details.

  3. Published "Copilot Engine Prerequisites on GHES" (https://github.github.com/gh-aw/troubleshooting/common-issues/#copilot-engine-prerequisites-on-ghes): "The following demonstrates enterprise Copilot endpoint routing only if that endpoint is available for your account and deployment; it is not a GHES support promise."

  4. Source, same content:

    • docs/src/content/docs/reference/engines.md line 158: "For GHES Copilot use api.enterprise.githubcopilot.com." Line 169 explains that GITHUB_COPILOT_BASE_URL routes through engine.env.
    • docs/src/content/docs/reference/enterprise-configuration.md line 13 (the not-end-to-end callout) and line 163 (the link to the GHES prerequisites).
    • docs/src/content/docs/troubleshooting/common-issues.md lines 263–269 (the GHES section and its "not a GHES support promise" caveat).
  5. Other pages repeat the endpoint without the caveat: docs/src/content/docs/reference/self-hosted-runners.md lines 464–469 and docs/src/content/docs/troubleshooting/common-issues.md lines 274–278 (the same api-target example, with no GHES qualifier).

Not verified: whether the deployed site differs from HEAD (no deployment SHA was visible). Whether api.enterprise.githubcopilot.com is available on a particular GHES release. I did not check GitHub's public docs for that.

Dedup: searched OPEN and CLOSED issues for "enterprise-docs GHES api-target", "GHES Copilot api.enterprise.githubcopilot.com", and "enterprise-docs ca-cert" (no cookie-label match). Related closed issues: #20968 (GHES prerequisites guide, completed 2026-03-15; it proposed the common-issues section, which now carries the caveat), and #20967 (actionable GHES errors). Neither covers the Engines reference sentence. No open match.

Proposed improvement and acceptance criteria

Make the Engines reference match the qualified wording in Enterprise configuration and Troubleshooting. In docs/src/content/docs/reference/engines.md line 158, replace the unqualified sentence with a link to "Copilot Engine Prerequisites on GHES", and state that the endpoint is available only where the enterprise confirms it for its deployment. Apply the same qualification to the api-target examples in self-hosted-runners.md (lines 464–469) and common-issues.md (lines 274–278), or link them to the GHES caveat.

Acceptance criteria:

  • On /gh-aw/reference/engines/, the GHES sentence links to the GHES prerequisites section and carries the same "not a GHES support promise" qualifier.
  • Starting from the Engines page, a GHES reader reaches the licensing and firewall prerequisites in one click.
  • The api-target examples in self-hosted-runners.md and common-issues.md do not state GHES support without the qualifier.
  • No other GHES support statements change.

Generated by Enterprise Docs Audit · copilot · routed: haiku55 xhigh · ~16 AIC · ⌖ ~2 AIC · ⊞ 5.7K · ◷

Activity

  1. linked a pull request that will close this issueQualify GHES Copilot endpoint guidance #76896on Nov 11, 2026
  2. github-actions commented on Nov 11, 2026

    @github-actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, Copilot will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt50 · ~1 AIC · ⌖ ~1 AIC · ⊞ 11.7K · ◷

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

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions