How to release a new update.

[tbergkvist]

How to release a new update to pypi.

This is a guide intended for the pynanovna developers and maintainers.

Note on versions.

Keep to the major, minor, patch standard.

Do not publish breaking changes in a patch or minor update.

Try to bundle together a lot of new features for a minor update.

Major updates should be planned over long time and talked through with other developers.

Before releasing.

Make sure to test the code on at least two different devices.

• Pull the latest code from github.
• Run the tests in the tests/ directory.
• Run all the example files in the examples/ directory.

Make sure that the code is Black formatted.

• Run black . from the project root directory.

Releasing.

At time of writing, pynanovna uses poertry to build the dist and docs, and twine to publish to pypi.

• Change all version numbers to the new. Do a search for the current version and change it to the new in all files.
• Run poetry build.
• Install the package locally with pip install . from the project root directory.
• Run the tests in the tests/ directory again.
• Run all the example files in the examples/ directory again.
• Run pip uninstall pynanovna.
• If all has worked out well, copy the API token from pypi.
• Run twine upload dist/* and paste the token when asked for.

After release.

• Push all the code to a new branch named: release/v0.0.0 (with the new version number instead of 0.0.0).
• Create a pull request and merge with main.
• Install pynanovna and make sure you get the new update.
• Test the package and verify that it works.
• Create a new release on the github project page.