How to release a new version#

To follow these steps, you need to be one of the maintainers for imod on both PyPI and conda-forge, as well as access to the Deltares Teamcity build environment.

  1. Update the Changelog and the __version__ in imod/__init__.py, and the version entry in the pixi.toml for complenetess.

  2. Create a tag on your local machine and push it GitHub. Old tags are here. Old releases are here. The tag name should be vx.y.z, where x, y and z are version numbers according to Semantic Versioning.

  3. On Teamcity go to the Deploy All build step in the Deploy project.

  4. Press the Run button and select the Changes Tab.

  5. Select the branch/tag you want to release and press Run Build

The TeamCity pipeline will:

  1. Create a release on GitHub

  2. Create the imod-python package and upload it to PyPi

  3. Build the documentation and deploy it