docs: correct the deployment story in the README - #37
Merged
Conversation
The README claimed "Any push to the `main` branch will trigger an automatic build and deployment". That has not been true since deployment was gated on `release: published`: pushing to `main` runs ci.yml, which verifies and stops. Anyone following the README would push, watch a green check, and wonder why production had not moved. docs/TOOLCHAIN.md had already flagged the drift. - Describe both workflows and what each one does, so the split between verification and deployment is explicit - Spell out the actual release path: land via pull request (branch protection requires it), `chore(release): X.Y.Z`, tag, publish the release - Point at docs/TOOLCHAIN.md for the full reference - Document `bun run gate`, which the pre-push hook and CI both enforce but the README never mentioned - Fix the live site link: the canonical host is libredb.org, and libredb.github.io 301-redirects to it TOOLCHAIN.md's closing note recorded this inconsistency as outstanding; it now records it as resolved, so the two documents agree. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Why
The README said:
That has not been true since deployment was gated on
release: published. Pushing tomainrunsci.yml, which verifies and stops. Anyone following the README would push, watch a green check, and wonder why production had not moved.docs/TOOLCHAIN.mdhad already flagged the drift in its closing note.What changed
Both workflows documented, so the split between verification and deployment is explicit:
ci.ymlmaindeploy.ymlrelease: published(or manual dispatch)The real release path is spelled out: land via pull request (branch protection requires it),
chore(release): X.Y.Z, tag, publish the release.bun run gatedocumented — the pre-push hook and CI both enforce it, but the README never mentioned it.Live site link fixed — the canonical host is
libredb.org;libredb.github.io301-redirects to it (verified).docs/TOOLCHAIN.mdrecorded this inconsistency as outstanding; it now records it as resolved, so the two documents agree.Documentation only — no site output changes.
Verification
bun run gateclean: 0 typecheck errors, Prettier clean, oxlint clean, knip clean, 66 tests pass.🤖 Generated with Claude Code