Docs: Add app administration guide#297
Merged
ModeSevenIndustrialSolutions merged 1 commit intoJul 22, 2026
Merged
Conversation
Document the GitHub App permissions and event subscriptions that operators must keep enabled, including the GitHub UI display names for webhook events. Also describe how to apply changes to an already-running app, including manual settings sync and the re-approval nuance for permission changes. This addresses enablement confusion from dcoapp#289, dcoapp#290, and dcoapp#292. Clarify permission scopes, adding-permission re-approval, and the organization-owned app settings path. Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
@tykeal is attempting to deploy a commit to the DCO App Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
Adds an Administration guide to document the GitHub App permissions and webhook event subscriptions required to operate a self-hosted DCO App, and links to it from existing entry points so operators can find it during deployment and troubleshooting.
Changes:
- Add new
docs/administration.mdoperator/admin guide covering required permissions, required events, and post-change verification steps. - Link to the new guide from
README.mdanddocs/deploy.mdto improve discoverability.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds a pointer to the new administration guide for existing deployments. |
| docs/deploy.md | Links to the administration guide from the deployment docs. |
| docs/administration.md | Introduces a detailed permissions/events reference plus guidance for updating an already-running GitHub App. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ModeSevenIndustrialSolutions
approved these changes
Jul 22, 2026
ModeSevenIndustrialSolutions
merged commit Jul 22, 2026
da42514
into
dcoapp:main
7 of 8 checks passed
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.
Summary
Adds an operator/admin guide documenting the GitHub App permissions and event subscriptions needed for DCO App deployments, with Repository vs Organization permission scope called out explicitly.
The guide also covers GitHub UI display-name mapping for events, notably
merge_groupas Merge queue entry, and explains how to apply changes to an already-running app: manual settings sync, the adding-permission re-approval nuance, and both organization-owned and personal-account settings paths.Motivated by the enablement confusion behind #289, #290, and #292.
Validation
pre-commit run --all-filesExpected checks
testshould pass; this is docs-only and Jest behavior is unaffected.preview-smokeis expected to fail because there is no authorized Vercel preview for this SHA.Vercelorganization gate is expected.