Venn

Maintainer guide#

This folder holds material for maintainers. User documentation lives one level up.

Everyday checks#

The tracked tree is the public tree. A test checks that no private material (design notes, run outputs, weights, caches) is tracked.

python -m pyflakes venn scripts examples tests
python scripts/check_docs.py
python -m pytest -q
python -m build

Release#

  1. Update the version in pyproject.toml and CITATION.cff.
  2. Build the site and the wheel locally and smoke-test the wheel from outside the checkout: venn quickstart and venn sweep --rows 19 --batch-size 8.
  3. Tag vX.Y.Z on main. CI checks the tag against the project version, runs everything and uploads the distributions as a workflow artifact.
  4. Publish the distributions through the manually dispatched Trusted Publishing workflow after the launch decision (see PyPI setup).

The decision head is published separately; see publishing the head. The documentation site is described in website.

History hygiene#

Deleting a file from the tree does not remove it from Git history. Before changing repository visibility, inspect the full history for anything that must not be public and rewrite it if necessary.

View this page on GitHub

On this page