docs(submitqueue): provider example configuration and landing runbook - #548
Open
behinddwalls wants to merge 1 commit into
Open
docs(submitqueue): provider example configuration and landing runbook#548behinddwalls wants to merge 1 commit into
behinddwalls wants to merge 1 commit into
Conversation
This was referenced Aug 7, 2026
behinddwalls
marked this pull request as ready for review
August 7, 2026 18:24
behinddwalls
force-pushed
the
sq/provider-example
branch
from
August 7, 2026 18:36
91fc4e0 to
36df886
Compare
behinddwalls
force-pushed
the
sq/provider-example
branch
from
August 7, 2026 21:21
36df886 to
c18856d
Compare
behinddwalls
force-pushed
the
sq/provider-example
branch
from
August 7, 2026 22:19
c18856d to
616b8c9
Compare
behinddwalls
force-pushed
the
sq/provider-example
branch
2 times, most recently
from
August 7, 2026 23:00
3b40469 to
b3b074d
Compare
behinddwalls
force-pushed
the
sq/provider-example
branch
from
August 7, 2026 23:24
b3b074d to
f5249b5
Compare
## Summary ### Why? Every piece needed to land a change against a live provider was in place, but nothing said how to point the stack at one — and the pieces that vary by provider were scattered across environment variables and two config files with no worked example. ### What? Which provider a deployment targets becomes a bind-mounted directory: `make local-provider-start PROVIDER=github` mounts `example/provider/<name>/` into the orchestrator and Runway. Because the choice is a mount rather than a build input, switching providers needs no rebuild, and adding one is a directory plus the extension implementations behind it — no compose, Makefile, or image change. The compose overlay names no provider at all. It requires the token rather than defaulting it: falling back to the fake integrations would let the stack report a change as landed without having gone near the provider, which is a far worse failure than not starting. `example/provider/README.md` carries the complete touchpoint list for adding a provider, and — more usefully — what is *not* on it: the merger's apply and push paths, the head-branch update, the pipeline, the wire contract, and the hermetic git E2E are all provider-independent. The runbook covers the two first-run traps that are easy to misdiagnose. Branch protection on the target rejects the merger's push like anyone else's. And a change that lands but stays open is either a fork (expected and permanent — its head branch lives in another repository) or head-branch protection blocking the update; Runway's logs distinguish them. ## Test Plan ✅ `docker compose -f docker-compose.yml -f docker-compose.provider.yml config` validates, and fails fast with `required variable GITHUB_TOKEN is missing a value` when the token is unset. ✅ `make help` lists `land`, `local-provider-start`, and `local-provider-stop`. Landing against a live provider is manual by nature — it needs a scratch repository and a token, so it is not automated in CI. The runbook is the procedure. # Conflicts: # service/submitqueue/demo/provider/README.md # service/submitqueue/demo/provider/github/merge.yaml # service/submitqueue/demo/provider/github/profiles.yaml
behinddwalls
force-pushed
the
sq/provider-example
branch
from
August 7, 2026 23:42
f5249b5 to
41d19a9
Compare
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
Why?
Every piece needed to land a change against a live provider was in place, but nothing said how to point the stack at one — and the pieces that vary by provider were scattered across environment variables and two config files with no worked example.
What?
Which provider a deployment targets becomes a bind-mounted directory:
make local-provider-start PROVIDER=githubmountsexample/provider/<name>/into the orchestrator and Runway. Because the choice is a mount rather than a build input, switching providers needs no rebuild, and adding one is a directory plus the extension implementations behind it — no compose, Makefile, or image change.The compose overlay names no provider at all. It requires the token rather than defaulting it: falling back to the fake integrations would let the stack report a change as landed without having gone near the provider, which is a far worse failure than not starting.
example/provider/README.mdcarries the complete touchpoint list for adding a provider, and — more usefully — what is not on it: the merger's apply and push paths, the head-branch update, the pipeline, the wire contract, and the hermetic git E2E are all provider-independent.The runbook covers the two first-run traps that are easy to misdiagnose. Branch protection on the target rejects the merger's push like anyone else's. And a change that lands but stays open is either a fork (expected and permanent — its head branch lives in another repository) or head-branch protection blocking the update; Runway's logs distinguish them.
Test Plan
✅
docker compose -f docker-compose.yml -f docker-compose.provider.yml configvalidates, and fails fast withrequired variable GITHUB_TOKEN is missing a valuewhen the token is unset.✅
make helplistsland,local-provider-start, andlocal-provider-stop.Landing against a live provider is manual by nature — it needs a scratch repository and a token, so it is not automated in CI. The runbook is the procedure.
Stack