Repository navigation
docs(full-platform): split the slack approver into two github apps - #50
Merged
Merged
Conversation
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.
What changes
Corrects
full-platform/slack-approval-gateway.md: what was documented as one GitHub App (microtodosuite-slack-approver) covering both gates is now two --microtodosuite-gitops-slack-approver(write access, installed only onmicroservice-app-gitops) andmicrotodosuite-prod-gate-notifier(read-only, installed on the five service repos, no private key stored anywhere).Why
GitHub Apps declare one permission set that applies uniformly to every repository they are installed on -- there is no way to grant write access on one installed repo and read-only on another within the same App. The original single-App design would have left unused write permission (Pull requests, Contents) sitting on all five service repos just because the App also needed it on
microservice-app-gitops. Splitting into two Apps removes that: the notifier App genuinely cannot write anywhere, because it is never granted the permission to.Tasks
No task register covers this work (same as the original PR #49).
How it is verified
Re-derived directly from GitHub's own documented constraint (one permission set per App installation, confirmed during the original design's research pass) -- not a new claim, a correction of scope assignment within the same known facts.
Risk and rollback
None: documentation only, and no GitHub App has been created yet under either name. Rollback is
git revertthis commit.What this PR does not do
Does not change the Terraform module (
aws/shared/slack-approval-gateway/, already merged in #106) -- it needs no change, since it already only ever consumes one App's id/key (the one that can write) and a shared webhook secret both Apps use. Does not create either GitHub App.