Create 030 release (#145)

* add release docs

* Bump version: 0.2.1 → 0.3.0

* updated whatsnew

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.1
+current_version = 0.3.0
 commit = True
 tag = True
 

docs/CONTRIBUTING.md

@@ -58,3 +58,18 @@
 - ``conda activate kw_env``
 - ``bumpversion major`` or ``bumpversion minor`` or ``bumpversion patch``
 - the version number of all relevant files will be updated, as stated in setup.cfg
+
+## Create release
+
+- make sure the ``main`` branch is up to date (important issues solved, all pullrequests and branches closed)
+- bump the versionnumber with ``bumpversion minor``
+- update ``docs/whats-new.md`` and add a date to the current release heading
+- run local testbank
+- local check with: ``python -m build`` and ``twine check dist/*`` ([does not work on WCF](https://github.com/pypa/setuptools/issues/4133))
+- copy the kenmerkendewaarden version from [pyproject.toml](https://github.com/Deltares-research/kenmerkendewaarden/blob/main/pyproject.toml) (e.g. ``0.3.0``)
+- create a [new release](https://github.com/Deltares-research/kenmerkendewaarden/releases/new)
+- click ``choose a tag`` and type v+versionnumber (e.g. ``v0.3.0``), click ``create new tag: v0.11.0 on publish``
+- set the release title to the tagname (e.g. ``v0.3.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/kenmerkendewaarden)

docs/whats-new.md

@@ -1,10 +1,10 @@
 # What's new
 
-## UNRELEASED
+## 0.3.0 (2024-10-01)
 
 ### Feat
 - from meters to centimeters and other updates for dashboard in [#142](https://github.com/Deltares-research/kenmerkendewaarden/pull/142)
-- added tidalrange to slotgemiddelden in [#142](https://github.com/Deltares-research/kenmerkendewaarden/pull/142)
+- added tidalrange to slotgemiddelden and outputformats to accomodate SAS dashboard in [#142](https://github.com/Deltares-research/kenmerkendewaarden/pull/142)
 
 ### Fix
 - accomodate updated astrog datetime handling in hatyan 2.9.0 in [#141](https://github.com/Deltares-research/kenmerkendewaarden/pull/141)

kenmerkendewaarden/__init__.py

@@ -4,7 +4,7 @@
 
 __author__ = """Jelmer Veenstra"""
 __email__ = "[email protected]"
-__version__ = "0.2.1"
+__version__ = "0.3.0"
 
 from kenmerkendewaarden.data_retrieve import *
 from kenmerkendewaarden.data_analysis import *

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "kenmerkendewaarden"
-version = "0.2.1"
+version = "0.3.0"
 maintainers = [{ name = "Jelmer Veenstra", email = "[email protected]" }]
 description = "Derive indicators from waterlevel measurements"
 readme = "README.md"