From c71de8b93bba91d5c603e3c2f3f4b5f1a8041b41 Mon Sep 17 00:00:00 2001 From: Martijn Visser Date: Tue, 23 Jul 2024 20:18:04 +0200 Subject: [PATCH] Update release process a bit --- docs/changelog.qmd | 2 -- docs/dev/release.qmd | 5 +++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/changelog.qmd b/docs/changelog.qmd index 2f56e36c8..41bc57e42 100644 --- a/docs/changelog.qmd +++ b/docs/changelog.qmd @@ -36,8 +36,6 @@ For this release we said goodbye to the problematic FractionalFlow node, but wel - Removed unneeded static table from Terminal. #1624 - Removed FractionalFlow node. #1616 -### Changed - ## [v2024.9.0] - 2024-06-20 ### Added diff --git a/docs/dev/release.qmd b/docs/dev/release.qmd index 3f64c3678..45db98426 100644 --- a/docs/dev/release.qmd +++ b/docs/dev/release.qmd @@ -59,8 +59,7 @@ git push --tags This will trigger a workflow on TeamCity that will publish a new release on GitHub as soon as it is finished. You can follow the progress [here](https://dpcbuild.deltares.nl/buildConfiguration/Ribasim_Ribasim_MakeGitHubRelease?mode=builds). It also auto-generates a changelog. -You'll probably want to curate that by rearranging the most important changes for users to the top in the form of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). -The possibly long list of generated release notes can put below an "All changes" collapsed item as such: +You need to edit that by moving the auto-generated contents, except the "Full Changelog" link, in a collapsed details block as shown below. ```
@@ -74,6 +73,8 @@ All changes ``` +Now copy the manually edited changelog entry from changelog.qmd above the details, such that the edited changelog can be seen both from our documentation as well as GitHub releases. + ## Release the Ribasim Python packages to PyPI To be able to install packages with `pip`, they need to be released on the Python Package Index (PyPI).