Release Process¶
For maintainers only:
Update
CHANGELOG.mdwith the version changesUpdate
docs/as requiredUpdate
README.mdas requiredCommit changes
Run
bump2version <major|minor|patch>to update the version number (pick one of the options)Version number on
pyproject.tomlwill be updated automaticallyYou can specify the
--new_versionflag in case you wish to manually set the newest version (if not provided, it will be done automatically based on the chosen option)The command also creates a git tag
Run
poetry buildto package the new version artifactsRun
poetry publishto publish the packages