Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release process a bit #1657

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Update release process a bit #1657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/changelog.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions docs/dev/release.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
<details>
Expand All @@ -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).
Expand Down