Deployment

Overview

By deployment, we understand release of a new package version that is available for the users.

Preconditions

To check whether the package is ready for the next release, please use the checklist below. All bullet points shall be satisfied.

• For a release milestone, are there all issues closed?
• Is readme file up to date?
• Is documentation updated for all new features?
• Are all critical issues fixed?

Completion

To fully release new version of the package, please make sure that all of these steps are completed:

• Assign new version according to semantic versioning.

• Upload documentation for new version:

  • UDS - ReadTheDocs
  • UDS - GitHub Pages

• Upload new version to PyPI (with release notes attached).

  • python -m pip install -U setuptools

  • python -m pip install -U wheel

  • python -m pip install -U build

  • python -m build --wheel

  • python -m pip install --upgrade twine

  • python -m twine upload --repository testpypi dist/* # to upload to test server first

  • python -m twine upload --repository pypi dist/*

    When using twine, you will be prompted for a username and password. For the username, use __token__. For the password, use the token value, including the pypi- prefix.

• Add tag to git commit with released version of the package as described here.