Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 1.23 KB

RELEASING.md

File metadata and controls

44 lines (37 loc) · 1.23 KB

Releasing PyTissueOptics

1. Prerequisites

  • You must have permission to publish to PyPI.
  • Ensure the following tools are installed and up to date: 
    pip install --upgrade build twine
  • Local git repository is clean. 
    git checkout main
git pull origin main

A note on versioning:

PyTissueOptics uses setuptools_scm, which automatically infers the package version from Git tags. Follow Semantic Versioning to tag releases as vMAJOR.MINOR.PATCH (e.g., v2.0.1). Development versions are built from commits after the latest tag and look like v2.0.1.dev3+gabc123.d20251108.

2. Create a Git tag

git tag vX.Y.Z
git push origin vX.Y.Z

3. Build the package

rm -rf dist/
python -m build

4. Upload to PyPI

python -m twine upload dist/*

5. Publish GitHub Release

Used to announce and document the changes in the new version.

  • Go to the GitHub releases page
  • Click on "Draft a new release"
  • Select the tag you created earlier
  • Fill in the release title and description (generate changelog from last tag).
  • Click "Publish release"