Here is the checklist to run before releasing a new version for mbtrack2:
- Create a new local branch from the merge develop (with all the feature branch intended to be included in the new version).
- Go into mbtrack2 root folder.
- Run the isort formatter:
isort .
- Run the yapf formatter:
yapf -ir mbtrack2
- Update the pyproject.toml file with version number, new dependencies and so on.
- Update README.md
- Run poetry:
poetry env use python
poetry install
- Check that the tests run without errors:
poetry run pytest
poetry build
- Test build on test pypi:
poetry config repositories.test-pypi https://test.pypi.org/legacy/
poetry config http-basic.test-pypi <username> <password>
poetry publish test-pypi
- Install in a clean virtual environment (e.g. google colab) to check that it is ok using:
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple mbtrack2
- Merge to stable with a new tag and changelog.
- Publish on pypi:
poetry config http-basic.pypi __token__ api_token
poetry publish