Prep for 2.3.0 release

CHANGELOG.md

@@ -6,6 +6,8 @@ Formatted as described on [https://keepachangelog.com](https://keepachangelog.co
 
 ## [Unreleased]
 
+### [2.3.0] (2024-08-29)
+
 ## Changed
 
 - Use [conda-lock](https://conda.github.io/conda-lock/) to install reproducible conda dependencies. Instead of loosely pinned environment.yml ([#442](https://github.com/eWaterCycle/ewatercycle/pull/442))
@@ -255,7 +257,8 @@ Everthing listed at [2.0.0](2.0.0), but without the adding models part.
 - Empty Python project directory structure
 - Added symlink based data files copier
 
-[Unreleased]: https://github.com/eWaterCycle/ewatercycle/compare/2.2.0...HEAD
+[Unreleased]: https://github.com/eWaterCycle/ewatercycle/compare/2.3.0...HEAD
+[2.3.0]: https://github.com/eWaterCycle/ewatercycle/compare/2.2.0...2.3.0
 [2.2.0]: https://github.com/eWaterCycle/ewatercycle/compare/2.1.1...2.2.0
 [2.1.1]: https://github.com/eWaterCycle/ewatercycle/compare/2.1.0...2.1.1
 [2.1.0]: https://github.com/eWaterCycle/ewatercycle/compare/2.0.0...2.1.0

CONTRIBUTING.md

@@ -83,35 +83,36 @@ your pull request.
 This section is for maintainers of the package.
 
 1. Checkout ``HEAD`` of ``main`` branch with ``git checkout main`` and ``git pull``.
-2. If dependencies have changed then create a new [conda lock](https://conda.github.io/conda-lock/) file with ``conda-lock lock -f pyproject.toml``.
-3. Determine what new version (major, minor or patch) to use. Package uses `semantic versioning <https://semver.org>`_.
-4. Set new version in ``pyproject.toml`` file in project section.
-5. Update CHANGELOG.md with changes between current and new version. (Don't forget to also update the links at the bottom of the file)
-6. Make sure pre-commit hooks are green for all files by running ``pre-commit run --all-files``.
-7. Make sure types are correct by running ``mypy``.
-8. Make sure all tests passed by running ``pytest``.
-9. Commit & push changes to GitHub.
-10. Wait for [GitHub
+1. Determine what new version (major, minor or patch) to use. Package uses `semantic versioning <https://semver.org>`_.
+1. Because main branch is protected, you need to create a new branch with ``git checkout -b release-<version>``.
+1. If dependencies have changed then create a new [conda lock](https://conda.github.io/conda-lock/) file with ``conda-lock lock -f pyproject.toml``.
+1. Set new version in ``pyproject.toml`` file in project section.
+1. Update CHANGELOG.md with changes between current and new version. (Don't forget to also update the links at the bottom of the file)
+1. Make sure pre-commit hooks are green for all files by running ``pre-commit run --all-files``.
+1. Make sure types are correct by running ``mypy``.
+1. Make sure all tests passed by running ``pytest``.
+1. Commit & push changes to GitHub.
+1. Create a pull request, review it, wait for actions to be green and merge the pull request.
+1. Wait for [GitHub
     actions](https://github.com/eWaterCycle/ewatercycle/actions?query=branch%3Amain+)
-    to be completed and green.
-
-11. Create a [GitHub release](https://github.com/eWaterCycle/ewatercycle/releases/new)
+    on main branch to be completed and green.
+1. Create a [GitHub release](https://github.com/eWaterCycle/ewatercycle/releases/new)
 
     - Use version as title and tag version.
     - As description use intro text from README.md (to give context to
         Zenodo record) and changes from CHANGELOG.md
 
-12. Verify
+1. Verify
 
     1. Has [new Zenodo
         record](https://zenodo.org/search?page=1&size=20&q=ewatercycle)
         been created?
-    2. Has [stable
+    1. Has [stable
         ReadTheDocs](https://ewatercycle.readthedocs.io/en/stable/) been
         updated?
-    3. Has the [Github publish action](https://github.com/eWaterCycle/ewatercycle/actions/workflows/python-publish.yml)
+    1. Has the [Github publish action](https://github.com/eWaterCycle/ewatercycle/actions/workflows/python-publish.yml)
         successfully uploaded the archives to [PyPI](https://pypi.org/project/ewatercycle/)?
-    4. Can new version be installed with pip using
+    1. Can new version be installed with pip using
         `pip3 install ewatercycle==<new version>`?
 
-13. Celebrate
+1. Celebrate