Braingeneers Release Instructions

1. Create a fresh clone and create (example) branch v0.1.x:

    git clone https://github.com/braingeneers/braingeneerspy
    cd braingeneerspy
    git checkout -b v0.1.x
   

2. In a direct commit to _version.py in your clone, bump project version from 0.0.0.dev0 to 0.1.0 in _version.py, and push.

    git add _version.py
    git commit
    git push origin v0.1.x
   

3. In your fresh clone, build the updated branch in a virtualenv:

    virtualenv --system-site-packages -p python3.10 --never-download venv
    . venv/bin/activate
    pip install -e .[all]
   

4. Tag the HEAD commit on the v0.1.0 and push that tag:

   git tag -a 'v0.1.0' -m 'v0.1.0'
   git push origin v0.1.0
   

5. (Optional) Ensure you have PyPI access to push here: https://pypi.org/project/braingeneers/ . If you do not have one already, mint a PyPI API token with permissions for this project here: https://pypi.org/manage/account/

6. PyPI - WARNING: This step cannot be redone!

    pip install pip --upgrade
    pip install setuptools wheel build twine hatchling hatch-vcs --upgrade
    python -m build -n
    twine upload dist/*
   

7. On GitHub create a release pointing to this tag. Include release notes giving an overview of bug fixes and new features in this release. Use the Draft Changelog, or the diff linked from the number of commits to master since the last release, to see the changes. Note contributors.