Skip to content

[Draft] GitHub Enterprise Server integration docs for Beta launch#10153

Draft
BeFunes wants to merge 5 commits into
mainfrom
ghes-beta-docs
Draft

[Draft] GitHub Enterprise Server integration docs for Beta launch#10153
BeFunes wants to merge 5 commits into
mainfrom
ghes-beta-docs

Conversation

@BeFunes
Copy link
Copy Markdown
Contributor

@BeFunes BeFunes commented Apr 14, 2026

Ticket: https://circleci.atlassian.net/browse/DOCSS-2018
Relates to https://circleci.atlassian.net/wiki/spaces/PES/pages/8329953304/GitHub+Enterprise+server+cloud+hybrid+-+Launch+Plan

Context

This draft was prepared by Benny (PM) ahead of her departure to give the team a head start on the Beta docs. The content is based on the state of the integration as of mid-April 2026 and reflects assumptions about what will ship with Beta (see launch plan and mockups )

Some of these assumptions may no longer hold. Customer feedback from Preview (CarGurus, Rakuten), implementation decisions made after this PR was created, or changes in product direction could all affect what's accurate here. Treat everything in this PR as a starting point that needs to be validated against the actual product
before merging.

page docs/guides/modules/integration/pages/github-app-configuration-for-github-enterprise-server.adoc and all related images & links should be good to go, this one went through a lot of review. These changes were previously included in this other PR that is now closed: #9996.

Sections marked // TODO [BETA] are explicitly flagged as incomplete. But even the sections that appear "done" should be reviewed for accuracy. Nothing here should be merged without confirmation.

How to review this PR

This PR should NOT be merged without verifying the content against the actual product.
Please work through the following review checklist, confirming each item with the
relevant team and/or by testing in production.

Content to verify with engineering (Sources of Change team)

  • Step 1 (register and install the GitHub App): The self-serve onboarding flow
    was mocked in Figma at the time this PR was created but not yet implemented. Check
    with the SOC team whether it has shipped. If yes, walk through the flow in production
    and document the steps with screenshots. If not, leave the TODO placeholder.
  • Step 2 (create a project): Walk through creating a project for a GHES-connected
    org in production. Confirm the flow matches what's documented (or update if it differs).
  • Step 3 (set up pipelines and triggers): Confirm the UI-based pipeline/trigger
    setup works end-to-end for GitHub App Server pipelines.
  • App configuration page (PR Add GitHub App configuration guide for GHES #9996 content): Confirm the required permissions and
    event subscriptions listed are still current. Check with Shaun Kaasten if unsure.
  • Managing installations: Check whether the UI for uninstalling/managing GHES
    installations has shipped. If yes, document it. If not, leave the TODO.
  • Supported GHES versions: Check with engineering whether a minimum GHES version
    has been finalized for Beta. If yes, add it to the prerequisites section.

Feature support to verify with specific teams

  • Chunk: Confirm with the AI team that Chunk works for GitHub App Server projects.
    If yes, verify it is removed from the "not yet available" list and the feature matrix
    shows Yes. If not yet working, revert those changes.
  • Rollbacks: Confirm with the D&R (Deploys & Rollbacks) team that rollback
    functionality works for GitHub App Server pipelines. Same: verify feature matrix
    and "not yet available" list are correct.
  • Deploy Pipelines: Check with D&R whether deploy pipelines work for GHES. The
    feature matrix has a TODO for this.
  • Terraform provider: Check whether the Terraform provider supports github_server
    pipelines and triggers. If yes, add a note.

General review

  • Read through the entire overview page and confirm all factual claims by testing in
    production where possible.
  • Check that the feature matrix column values are accurate for every row.
  • Verify all cross-references (xrefs) resolve correctly.
  • Confirm the "not yet available" list only contains things that are genuinely not
    available at the time of Beta launch.
  • Confirm the Beta banner language is appropriate.
  • Run Vale on changed files and address any blocking errors.

Internal references

  • Confluence setup guide (Preview, for context only): page ID 8425242652
  • Self-serve onboarding: see Figma mocks (check with SOC team for current status)
  • Jira: SC-1656 (epic), SC-2969 (Beta launch), SC-2755 (API docs)
  • Key contacts: Shaun Kaasten (lead engineer), Rafael (feature matrix verification)

BeFunes and others added 5 commits April 3, 2026 14:43
Add new overview page for GitHub Enterprise Server integration and update
12 existing pages to reflect GHES as an add-on VCS integration using the
GitHub App model. Updates include VCS lists, feature support tables,
pipeline values, trigger docs, and checkout references.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove passive voice ("have been deprecated" -> "are deprecated") in
  variables.adoc
- Clarify checkout description: HTTPS is used "when using the GitHub App
  integration" for both GitHub Cloud and GitHub Enterprise Server

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…erver"

Use "GitHub App Server" when referring to the pipeline type (as labeled
in the UI), and keep "GitHub Enterprise Server" only when referring to
the platform/integration itself.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@BeFunes BeFunes changed the base branch from main to ghes-preview-docs April 14, 2026 09:13
@BeFunes
Copy link
Copy Markdown
Contributor Author

BeFunes commented Apr 16, 2026

There are currently two linting errors, because the linter wants to add full stops at the end of the events in the list

* Delete
* Issue comment
* Meta
* Pull request
* Pull request review.
* Pull request review comment.
* Push

I don't love this - I'll hold for @rosieyohannan to recommend the best path forward

Base automatically changed from ghes-preview-docs to main May 22, 2026 22:14
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.

1 participant