Skip to content

Add GitHub App configuration guide for GHES#9996

Draft
BeFunes wants to merge 9 commits intomainfrom
ghes-github-app-configuration
Draft

Add GitHub App configuration guide for GHES#9996
BeFunes wants to merge 9 commits intomainfrom
ghes-github-app-configuration

Conversation

@BeFunes
Copy link
Contributor

@BeFunes BeFunes commented Feb 13, 2026

Summary

  • Add new reference and troubleshooting page for configuring the CircleCI GitHub App on GitHub Enterprise Server
  • Covers required repository permissions, event subscriptions, and why each is needed
  • Provides step-by-step instructions for updating permissions and resolving the "updated App permissions" warning
  • Adds nav entry under Integration > VCS integration

Test plan

  • Antora build completes with no errors related to the new page
  • Page renders at guides/integration/ghes-github-app-configuration/
  • Nav entry appears in the correct location under VCS integration
  • Review content accuracy with engineering team

🤖 Generated with Claude Code

New reference and troubleshooting page covering required permissions,
event subscriptions, and steps to update the CircleCI GitHub App
configuration on GHES.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@BeFunes BeFunes requested review from a team as code owners February 13, 2026 16:05
@BeFunes BeFunes marked this pull request as draft February 13, 2026 16:06
- Add overview section with context on App creation and ownership
- Move verification instructions higher in the page
- Add event subscriptions and permissions warning screenshots
- Add note about other permissions, convert explanations to bullet lists
- Remove GHES acronym from file name, nav, and content
- Apply style guide fixes (active voice, sentence length, terminology)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@BeFunes BeFunes force-pushed the ghes-github-app-configuration branch from db28d15 to 1671358 Compare February 16, 2026 15:17
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@BeFunes
Copy link
Contributor Author

BeFunes commented Feb 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

If your App configuration does not match the requirements above, you may see a warning in CircleCI on your GitHub App Server card: **"Some CircleCI features require updated App permissions."**

.Warning displayed when App permissions need updating
image::guides:ROOT:ghes-app-permissions-warning.png[CircleCI warning banner showing that some features require updated App permissions with a Learn how to fix this link,width=400]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried to fix the width to 400px, but it didn't work. @rosieyohannan

Copy link
Contributor

Choose a reason for hiding this comment

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

Currently we have CSS overriding individual image scaling. We do not have any images on the site that aren't full width. If we want to be able to scale images I can add this ability but would like to explore whether we actually want it first

Comment on lines +69 to +70
* Pull request review
* Pull request review comment
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The linter wants this:

Suggested change
* Pull request review
* Pull request review comment
* Pull request review.
* Pull request review comment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah agreed this rule is too strict. Currently Its set to flag a full stop when the list item is more than two words. We use a full stop when a list item is a full sentence or the end of a sentence. Just ignore for now and I will try to refine the rule

BeFunes and others added 3 commits February 17, 2026 14:58
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

2 participants