Update How to prepare the code for a release authored by Alexis GAMELIN's avatar Alexis GAMELIN
...@@ -5,18 +5,19 @@ Here is the checklist to run before releasing a new version for mbtrack2: ...@@ -5,18 +5,19 @@ Here is the checklist to run before releasing a new version for mbtrack2:
3. Run the isort formatter: `isort .` 3. Run the isort formatter: `isort .`
4. Run the yapf formatter: `yapf -ir mbtrack2` 4. Run the yapf formatter: `yapf -ir mbtrack2`
5. Update the pyproject.toml file with version number, new dependencies and so on. 5. Update the pyproject.toml file with version number, new dependencies and so on.
6. Run poetry: 6. Update README.md
7. Run poetry:
* `poetry env use python` * `poetry env use python`
* `poetry install` * `poetry install`
* Check that the tests run without errors: `poetry run pytest` * Check that the tests run without errors: `poetry run pytest`
* `poetry build` * `poetry build`
* Test build on test pypi: * Test build on test pypi:
* `poetry config repositories.test-pypi https://test.pypi.org/legacy/` * `poetry config repositories.test-pypi https://test.pypi.org/legacy/`
* `poetry config http-basic.test-pypi <username> <password>` * `poetry config http-basic.test-pypi <username> <password>`
* `poetry publish -r test-pypi` * `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` * `pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple mbtrack2`
* Install in a clean virtual environment (e.g. google colab) to check that it is ok. 8. Merge to stable with a new tag and changelog.
7. Merge to stable with a new tag and changelog. 9. Publish on pypi:
8. Publish on pypi:
* `poetry config http-basic.pypi <username> <password>` * `poetry config http-basic.pypi <username> <password>`
* `poetry publish` * `poetry publish`
\ No newline at end of file