GitHub Action¶

stratum ships as a composite GitHub Action that builds the binary from source (pure Go, no C toolchain) and runs it against your migrations, entirely offline on the runner.

Versioning

No release tag has been published yet, so the examples use @main. For reproducible builds, pin to a commit SHA (zvdy/stratum@<sha>).

Gate pull requests¶

The job fails when SCHEMA.md is stale, and the author regenerates and commits it themselves. No bot commits:

- uses: actions/checkout@v4
- uses: zvdy/stratum@main
  with:
    migrations-path: db/migrations
    output: SCHEMA.md
    check: "true"

Generate and push schema docs¶

- uses: actions/checkout@v4
- uses: zvdy/stratum@main
  with:
    migrations-path: db/migrations
    output: SCHEMA.md
    schema: public
    push: "true"

With push: "true" the action commits and pushes the regenerated SCHEMA.md back to the branch. The workflow needs contents: write permission and a checkout with credentials.

Inputs¶

Input	Default	Description
`migrations-path`	(required)	Path to the migrations directory
`output`	`SCHEMA.md`	Output file path
`schema`	`public`	Filter output to this schema name
`recursive`	`"false"`	Discover `.sql` files recursively
`push`	`"false"`	`git add` + `commit` + `push` the output file
`commit-message`	`chore: update schema docs`	Commit message used with `push`
`check`	`"false"`	Fail (without writing) if the output file is out of date
`verbose`	`"false"`	Log each parsed statement

See action.yml for the source of truth.