Release 2.3.0

[stap-m]

• Release date: 2024-05-06
• Release team: @nelekoehler @stap-m @NormanZielke

[stap-m]

Release postponed for 2 weeks

[nelekoehler]

Here is the to do list for this release:

1. All issues closed and all pull requests merged that are part of the release milestone.
2. Branch releases-v2.3.0 from dev.
3. Update version information and release date in VERSION file and CITATION.cff.
4. Change unreleased heading in CHANGELOG.md.
5. Create two pull requests.
6. Automated tests are successful.
7. PR reviews.
8. Merge both PRs.
9. Close release milestone.
10. Draft release.
11. Set as the latest release.
12. Press Publish release button.
13. Create new unreleased section in CHANGELOG.md.
14. Add build files to the release page.
15. Inform @adelmemariani and @MGlauer.

Detailled release workflow

[jh-RLI]

The release v2.3.0 files are now also available on the oep website. I assume you have to clear browser cache to see the updated content.

[jh-RLI]

I have noticed that the file or directory names for the release artefacts change slightly from time to time. For the oep, only the oeo.zip (called build-files.zip in earlier versions) is currently relevant. Just a hint that changing directory names might confuse others :) .

[stap-m]

Thanks. We'll check that.

[stap-m]

@nelekoehler did you rename the file build-files.zip to oeo.zip manually? The file name in the build job does not change: https://github.com/OpenEnergyPlatform/ontology/actions/runs/9172004175

@jh-RLI should we change the file name back?

[nelekoehler]

No, I did not rename it manually, but I recognized, when I downloaded the build-files again right now, that it automatically was downloaded with another file name and not build-files.zip. I don't know why that is, but if it is necessary I can change the file name.

[jh-RLI]

I think ‘oeo.zip’ is also fine. The main thing would be that it is transparent. Can we document all artefacts somewhere - what each artefact is for / what it contains? Or maybe there is already a description.

Besides transparency and consistency, the only reason to keep the old name is that users who automatically download each version from GitHub and then process the files programmatically reanaming the directory/filename can break their code.

On the OEP, everything remains the same anyway, as we only copy the folder with the version number from oeo.zip and store it next to all other versions on the oep server.