questrail / siganalysis / 33514860635
96%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 3
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 95.745% (+59.9%) from 35.878%
33514860635

push

github

matthewrankin 
Document the tooling in the README

The setup section described uv sync and four recipes, and the release
section described a just deploy that no longer exists. Both were the only
written record of how any of this works.

Say what the release does now and, more to the point, why: that pushing
the tag is the point of no return because PyPI never lets a version
number be reused, that everything before it is local and amendable, and
that the workflow rechecks on a runner what the recipe checked on a
laptop. The example shows the prompt with the entries beside the versions
they would produce, since that is the part someone cutting a release has
to answer.

Note that ruff and pyright are deliberately absent from the brew install
line. Both are pinned in uv.lock and reached through uv run, so every
recipe and every CI job uses one version. A brew install ruff would put a
second, unpinned copy on the path for an editor to find, and ruff
releases change how code is formatted: the editor would then reformat
code that the next lint rejects.

Add the CI, coverage, and Python version badges, and record that the
trusted publisher on PyPI is a one time setup living outside the
repository. The release notes section now points at the CHANGELOG, which
the release workflow posts on its own; docs/releases keeps the longer
notes written for v0.8.0, which predates that.

Claude-Session: https://claude.ai/code/session_0172QCPXBNzgH2mSoknY537H

180 of 188 relevant lines covered (95.74%)

0.96 hits per line

Jobs
ID Job ID Ran Files Coverage
1 33514860635.1 3
95.74
 GitHub Action Run
Source Files on build 33514860635