Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
00ea1da
docs(auth): add an adoption-oriented guide to authentication and auth…
aparajon Aug 17, 2026
5d62320
docs(auth): add a service-calling section and config/payload examples
aparajon Aug 17, 2026
6d8802a
docs: match GitHub's anchor slugs for headings with removed punctuation
aparajon Aug 17, 2026
eb6b6b6
docs(auth): use a fleet-wide schema query as the third service-caller…
aparajon Aug 17, 2026
53bf104
docs(auth): flesh out the service-calling section as a consumer guide
aparajon Aug 17, 2026
077ff5f
docs(api): add an HTTP API consumer guide with payload examples
aparajon Aug 17, 2026
e749b28
Revert "docs(api): add an HTTP API consumer guide with payload examples"
aparajon Aug 17, 2026
6fd53c9
docs(auth): frame step 1 around infrastructure requirements
aparajon Aug 17, 2026
744e506
docs(auth): orient CLI-only adopters in the intro
aparajon Aug 17, 2026
18aa075
docs(auth): diagram the two front doors in the intro
aparajon Aug 17, 2026
112e902
docs(auth): add a for-AI-agents section
aparajon Aug 17, 2026
317ecf4
docs(auth): allow supervised CLI reads in the agent guidance
aparajon Aug 17, 2026
1f65da6
docs(auth): recommend keeping production out of operator_environments
aparajon Aug 17, 2026
0dd4ad1
docs(auth): make production write access a workflow choice
aparajon Aug 17, 2026
414bd17
docs(auth): emphasize PR review value for multi-person teams in step 4
aparajon Aug 17, 2026
13f4961
docs(auth): note the PR workflow also fits single-developer setups
aparajon Aug 17, 2026
f247270
docs(auth): step 4 spectrum ends at GitHub-only production
aparajon Aug 17, 2026
0d22f3e
docs(auth): drop the service-identity rule from the agents section
aparajon Aug 17, 2026
83d7d3e
Update agent CLI usage guidelines in auth.md
aparajon Aug 17, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 37 additions & 2 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- [Declarative Schema](#declarative-schema)
- [Layers](#layers)
- [User Layer (CLI / PR Comments / API)](#user-layer-cli-pr-comments-api)
- [User Layer (CLI / PR Comments / API)](#user-layer-cli--pr-comments--api)
- [Status Checks and Branch Protection](#status-checks-and-branch-protection)
- [Apply Options](#apply-options)
- [Unsafe Changes](#unsafe-changes)
Expand Down Expand Up @@ -110,9 +110,44 @@ schemabot skip-revert -e staging <apply_id> # Finalize (Vitess)

Users can also run `schemabot plan` manually in a PR comment to re-plan without waiting for auto-plan.

The same flow as a timeline:

```
Developer GitHub PR SchemaBot Database
│ │ │ │
│ push schema change │ │ │
│───────────────────────▶│ webhook │ │
│ │──────────────────────▶│ auto-plan │
│ │ │──────────────────────▶│
│ │ plan comment (DDL) │ live schema │
│ review the diff │◀──────────────────────│◀──────────────────────│
│ │ │ │
│ "schemabot apply │ │ │
│ -e staging" │ webhook │ │
│───────────────────────▶│──────────────────────▶│ re-plan, lock, │
│ │ │ review gate, │
│ │ │ start execution │
│ │ │──────────────────────▶│
│ │ progress comment │ execute DDL │
│ │◀───── updates ────────│◀───── progress ───────│
│ │ │ (row copy → cutover) │
│ │ check run → green │ │
│ │◀──────────────────────│ │
│ merge the PR │ │ │
│───────────────────────▶│ webhook │ │
│ │──────────────────────▶│ clean up PR state, │
│ │ │ release locks │
│ │ │ │
```

The staging apply above repeats for each environment in the database's
[environment order](configuration.md#environment-order); production applies are
additionally gated on the staging check and the
[review gate](configuration.md#review-gate).

**Check Runs** — SchemaBot publishes aggregate GitHub checks that block merge until managed schema changes are applied. See [Status Checks and Branch Protection](#status-checks-and-branch-protection) below.

**API** — HTTP endpoints that both CLI and webhook use internally. The SchemaBot server exposes `/v1/plan`, `/v1/apply`, `/v1/progress`, `/v1/cutover`, etc.
**API** — HTTP endpoints that both CLI and webhook use internally. The SchemaBot server exposes `/api/plan`, `/api/apply`, `/api/progress`, `/api/cutover`, etc.

### Status Checks and Branch Protection

Expand Down
Loading
Loading