Repository navigation
Attach installable builds to releases and document a one-line install - #1
Merged
Merged
Conversation
Version tags now build, smoke-test and attach installable assets with SHA-256 checksums to the GitHub release. The README's quick start points at the v0.1.0 asset and keeps the from-source path for development. Co-Authored-By: Claude Opus 5.5 <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
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.
What and why
The README told people to clone and build quantkit before they could use it. This adds a release workflow and a one-line install from the GitHub release.
.github/workflows/release.ymlruns on av*tag, or by hand for an existing tag. It checks that the tag matches the package version, builds the wheel and sdist, smoke-tests the result in a clean environment, and attaches it withSHA256SUMS.txtto the release.v0.1.0release asset. The from-source instructions stay for development.How I verified it
v0.1.0tag, installed the wheel into a clean Python 3.12 venv, and ranquantkit --help(exit 0, version 0.1.0).v0.1.0and check the README's install command against the real asset.🤖 Generated with Claude Code