Describe releases from the changelog, and check that Cargo.toml has the CMake version #16
No reviewers
Labels
No labels
Kind/Bug
Kind/Chore
Kind/Docs
Kind/Feature
Kind/Security
Priority
High
Priority
Low
Reviewed
Duplicate
Reviewed
Invalid
Status
Blocked
Status
Needs-Decision
Status
Wontfix
No milestone
No assignees
1 participant
Notifications
Due date
No due date set.
Reference
Strawly-Music/desktop!16
Loading…
Reference in a new issue
No description provided.
Delete branch "release-notes"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Release descriptions
The 0.2.0 release was published with the tag as its title and an empty description, because the release step passed only the bundle folder to
actions/forgejo-release.A
v*tag now publishes a release titled "Strawly Music ". Its description comes from the new.forgejo/release-notes.sh, which prints:<release>entry indata/app.strawly.music.metainfo.xml,CHANGELOG.md, with the###headings moved up to##and wrapped lines joined, so each item is one line on the release page.There are no install steps, since the README covers them. The script fails when the summary or the changelog section is missing. The build job runs it for a tag before building, so a missing entry fails in seconds instead of after the 8-minute build. The release job checks out the repository, writes the notes and passes them with
release-notes-fileandtitle, which thev2branch of the action supports.The three existing releases were fixed by hand to match: all are titled "Strawly Music ", 0.2.0 has the generated description, and the Install sections are gone from 0.1.0 and 0.1.1.
Version check
check.shnow fails whenCMakeLists.txtandCargo.tomlhave different versions. The release workflow compares a tag withCMakeLists.txtonly, so a release with an old version inCargo.tomlwould have passed. The version is read from the[package]section only.Cargo.lockneeds no check of its own, since clippy runs with--lockedand fails when it does not matchCargo.toml.The README's test and CI paragraphs describe both changes.
Checked
check.shpasses inorg.kde.Sdk//6.11, with all 3 tests. The version check passes on copies of the two files with the same version, and fails with "CMakeLists.txt has version 0.2.0, but Cargo.toml has 0.2.1." when they differ.release-notes.shgives the right output for 0.2.0, 0.1.1 and 0.1.0, keeps the nested list under the Rust item, leaves out the link definitions at the end ofCHANGELOG.md, and fails for a version with no entry. Its 0.2.0 output is the description now on the 0.2.0 release.