docs(readme): how to deploy a release, and ignore the operator wrappers - #157
Merged
Conversation
RELEASING.md covers cutting a release but stops at the published artifacts; how to get one INTO a deployment lived only in shell history. Documents the four commands, run from the deployment directory, plus the two things that are easy to get wrong: --find-links is what lets the keel_trader wheel resolve its workspace siblings (so download them all), and `keel --version` must report [release] bound to a commit -- a (DIRTY) or [checkout] build corresponds to no commit and must not run against live funds. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
keel-live and keel-paper are deployment artifacts with config and db paths pinned; they get copied to ~/keel rather than tracked here. 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.
Two small chores that had been sitting outside the repo.
Deploying a release into a deployment
docs/RELEASING.mdcovers cutting a release but stops at the published artifacts. How to getone into a deployment (
~/keel) lived only in shell history, which is how a deployment ends upa version behind without anyone noticing. New Deploying a new version section in the README
documents the four commands, plus the parts that are easy to get wrong:
Release/,.venv) is relative to it--find-links Releaseis what lets the singlekeel_traderwheel resolve itskeel-core/keel-broker-*siblings, which is why step 1 downloads all the wheelskeelon PyPI is an unrelatedproject, so
pip install keelfetches a stranger's codekeel --versionis the check that matters — it must report[release]bound to a commit, and a(DIRTY)or[checkout]build corresponds to no commit and must not be run against live fundsa fresh process — but a long-running
keel tuikeeps the build it started withThe four commands were run against the live deployment as written;
keel --versionreturns exactlythe line quoted in the README.
Ignore the operator wrappers
keel-liveandkeel-paperare deployment artifacts with config and database paths pinnedtogether, copied to
~/keelrather than tracked here — the same treatment their sibling scriptsalready get. They were showing up as untracked in every
git status.🤖 Generated with Claude Code