TEST RUN 1 (R1)
One command mirrors CI. Run it before every push:
make ciIt runs these in order, and each is also usable on its own:
| Command | Does |
|---|---|
make check |
Lock file consistency, pre-commit on tracked and untracked files, ty, deptry |
make test |
pytest with coverage |
make docs-test |
Builds the documentation strictly, failing on any warning |
Everything else, or make help for the full list:
| Command | Does |
|---|---|
make install |
Creates the environment and installs the git hooks |
make docs |
Serves the documentation locally |
make build |
Builds a wheel into dist/ |
make check lints untracked files on purpose: pre-commit run -a skips them, which is how a new file passes locally and then fails in CI the moment it is committed.
Commits follow Conventional Commits; releases, the changelog and versioned documentation are automated on merge to main. Until a release App is configured, the release workflow skips itself instead of failing.
Generated from coregraft.