Changes
Page history
Update How to prepare the code for a release
authored
Oct 24, 2023
by
Alexis GAMELIN
Show whitespace changes
Inline
Side-by-side
How-to-prepare-the-code-for-a-release.md
View page @
1e7fb462
...
@@ -2,9 +2,10 @@ Here is the checklist to run before releasing a new version for mbtrack2:
...
@@ -2,9 +2,10 @@ Here is the checklist to run before releasing a new version for mbtrack2:
1.
Create a new local branch from the merge develop (with all the feature branch intended to be included in the new version).
1.
Create a new local branch from the merge develop (with all the feature branch intended to be included in the new version).
2.
Go into mbtrack2 root folder.
2.
Go into mbtrack2 root folder.
3.
Run the black formatter:
`black mbtrack2`
3.
Run the isort formatter:
`isort .`
4.
Update the pyproject.toml file with version number, new dependencies and so on.
4.
Run the yapf formatter:
`yapf -ir mbtrack2`
5.
Run poetry:
5.
Update the pyproject.toml file with version number, new dependencies and so on.
6.
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`
...
@@ -15,7 +16,7 @@ Here is the checklist to run before releasing a new version for mbtrack2:
...
@@ -15,7 +16,7 @@ Here is the checklist to run before releasing a new version for mbtrack2:
*
`poetry publish -r test-pypi`
*
`poetry publish -r test-pypi`
*
`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.
*
Install in a clean virtual environment (e.g. google colab) to check that it is ok.
6
.
Merge to stable with a new tag and changelog.
7
.
Merge to stable with a new tag and changelog.
7
.
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