[Draft] GitHub Enterprise Server integration docs for Beta launch#10153
Draft
BeFunes wants to merge 5 commits into
Draft
[Draft] GitHub Enterprise Server integration docs for Beta launch#10153BeFunes wants to merge 5 commits into
BeFunes wants to merge 5 commits into
Conversation
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>
4 tasks
Contributor
Author
|
There are currently two linting errors, because the linter wants to add full stops at the end of the events in the list I don't love this - I'll hold for @rosieyohannan to recommend the best path forward |
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.
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.adocand 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)
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.
org in production. Confirm the flow matches what's documented (or update if it differs).
setup works end-to-end for GitHub App Server pipelines.
event subscriptions listed are still current. Check with Shaun Kaasten if unsure.
installations has shipped. If yes, document it. If not, leave the TODO.
has been finalized for Beta. If yes, add it to the prerequisites section.
Feature support to verify with specific teams
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.
functionality works for GitHub App Server pipelines. Same: verify feature matrix
and "not yet available" list are correct.
feature matrix has a TODO for this.
github_serverpipelines and triggers. If yes, add a note.
General review
production where possible.
available at the time of Beta launch.
Internal references