docs: add controller GitHub App setup guide - #55
Merged
Conversation
Nickfost
force-pushed
the
docs/github-app-setup
branch
from
July 28, 2026 01:44
a472335 to
e615808
Compare
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a47233583a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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
1 participant
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.
Summary
Adds
docs/GITHUB-APP-SETUP.md: a from-scratch guide for creating the controller's GitHub App identity — why an app instead of a PAT, minimum permissions (contents: readon the config repo, org self-hosted runners write), key handling, installation scoping,host.envwiring, verification, troubleshooting (including the pending-permission-approval 403 case), and rotation.Why
The required app permissions were previously stated only as a one-line prerequisite in DESIRED-STATE.md. New operators had no walkthrough for creating the app, and the installation-approval step is an easy-to-miss failure mode (observed in practice: permission saved on the app but not accepted on the installation → 403 on fetch).
Testing
Docs-only. Links verified against existing docs (SECRETS.md, DESIRED-STATE.md); cross-links added from
docs/README.mdand the DESIRED-STATE prerequisite list.