Releasing#

Release steps:

  • create release branch

  • update the package version in pyproject.toml, the version in __init__.py is extracted from there

  • update the header in the changelog (preserve the unreleased header)

  • run local testbank: pixi run test

  • local check with: pixi run flit build and pixi run twine check dist/*

  • create PR and merge back to main

  • create a new release: Deltares/hydromt_delft3dfm

  • click choose a tag and type v+versionnumber (e.g. v0.1.0), click create new tag: v0.1.0 on publish

  • set the release title to the tagname (e.g. v0.1.0)

  • click Generate release notes and replace the What’s Changed info by a tagged link to docs/whats-new.md

  • if all is set, click Publish release

  • a release is created and the github action publishes it on PyPI: https://pypi.org/project/hydromt_delft3dfm

Post release:

  • Update the version to 0.1.1 (bump patch)

  • Initialise changelog unrelease/added/fixed/changed

  • Push and merge to main