Release Process¶
This checklist documents the release workflow for CausalRL.
1. Prep and version bump¶
- Update
crl/version.py. - Update
CHANGELOG.mdwith a new version section. - Update
CITATION.cff(version) andCITATION.bibif the year/version changes.
2. Run quality gates¶
ruff check .
ruff format --check .
mypy crl
pytest
make notebooks-smoke
mkdocs build --strict
python -m build
twine check dist/*
3. Tag and release¶
Create a GitHub release with the changelog highlights.
4. Publish to PyPI¶
5. Post-release¶
- Verify the PyPI page renders correctly and install works in a clean venv.
- Announce the release and link to the documentation.