The checklist for a release. CONTRIBUTING.md has the short version.
A release is a vX.Y.Z tag on a main commit. The tag push starts release.yml (binaries, SBOM, provenance and a draft GitHub Release) and publish-python.yml (wheels and sdist, published to PyPI after approval). publish.yml publishes the crates when you run it for the tag. Both publish jobs refuse a tagged commit that has not passed CI and release.yml.
These live in GitHub and the registries, not in the repository, so no review sees them change. Check them before a release, and after any change of maintainers.
- Environments.
crates-ioandpypi: required reviewers (the maintainers), and deployments limited to tags matchingv*.live-schwab: deployments limited to themainbranch. It holdsSCHWAB_APP_KEY,SCHWAB_APP_SECRETandSCHWAB_TOKENS_JSONfor the live conformance job inqualification.yml. Keep no repository-level copies of them: a repository secret reaches a run from any branch, so anyone who can push a branch could print it.
- Tag ruleset. Only maintainers may create, update or delete tags matching
v*, since a tag starts the release workflows. - Trusted publishers. On crates.io, each crate (
rustyschwab-types,rustyschwab,rustyschwab-mcp,rustyschwab-console,rustyschwab-dash) trusts repositoryEpistates/rustyschwab, workflowpublish.yml, environmentcrates-io. On PyPI,rustyschwabtrusts workflowpublish-python.yml, environmentpypi. - Branch protection on
main, with the checks CONTRIBUTING.md lists.
-
Live evidence. Run the live smoke and the read-only conformance sweep with
record. Commit the smoke report and any fixture diff, and update the live verification table in SUPPORT.md. Do not release a version whose README claims more than that table shows. -
Checks. CI is green on
mainfor the commit you will tag, on Linux, macOS and Windows, with the Python matrix. Run the Python checks incrates/schwab-pylocally too if you changed the bindings (cargo test,maturin develop,pytest,mypy --strict python/rustyschwab). -
Versions. Set the new version in one commit:
versionin the workspaceCargo.toml;- every internal
version = "…"on a path dependency incrates/*/Cargo.toml(rustyschwab-types,rustyschwab,rustyschwab-mcp,rustyschwab-console); versionincrates/schwab-py/Cargo.toml, and itsrustyschwabdependency.
Then
cargo update -wand, incrates/schwab-py,cargo update -p rustyschwab, so both lockfiles agree. CI and the publish workflows refuse a bindings version that differs from the SDK's, and a tag that differs from either. -
Changelog. Rename
## [Unreleased]to## [X.Y.Z] - YYYY-MM-DDand open a new empty## [Unreleased]. Every Breaking entry needs its migration notes.cargo-semver-checksruns only on pull requests, so for a release built from direct pushes tomain, runcargo semver-checksagainst the previous tag yourself. -
README. Update the status line and the install lines (
rustyschwab = "X.Y"). -
Dry runs.
cargo package -p rustyschwab-types -p rustyschwab -p rustyschwab-mcp -p rustyschwab-console -p rustyschwab-dash --locked, and runpublish-python.ymlby hand frommainto build and test the wheels and sdist without publishing.
- Tag the release commit and push the tag:
git tag -a vX.Y.Z -m vX.Y.Z && git push origin vX.Y.Z. - Wait for
release.ymlto pass. It runs the workspace tests on the tag, checks that the tag matches the crate version and that the binary list matches the packages, and drafts the GitHub Release. - PyPI.
publish-python.ymlbuilds the wheels and sdist, runs the test suite against the Linux wheel, and waits for approval in thepypienvironment. Approve it oncerelease.ymlhas passed; the job checks that it did, and that CI passed on the same commit, before it uploads. - crates.io. Run
publish.ymlfor the tag and approve it in thecrates-ioenvironment. It makes the same check, packages all five crates, then publishes them in dependency order. A release that adds a crate publishes that crate the first time with a short-lived API token, since trusted publishing cannot create a crate: from a clean checkout of the tag,cargo publish -p <crate> --locked, then add the crate's trusted publisher and revoke the token. - Review and publish the drafted GitHub Release. Verify an artifact with
gh attestation verify <file> --repo Epistates/rustyschwab.
- Install from the registries in a clean environment (
cargo install rustyschwab-mcp,pip install rustyschwab) and run the README quickstarts. - Check the docs.rs builds of all five crates.
- Watch for a stable TurboMCP 4.x;
rustyschwab-mcppins=4.0.0-alpha.5until then (see SUPPORT.md).