Release

Create a new release for Speed of Sound version $ARGUMENTS.

Release channels:

• alpha (e.g. 1.2.3-alpha.1): GitHub pre-release only.
• beta (e.g. 1.2.3-beta.1): GitHub pre-release + Snapcraft/Flathub beta channels.
• stable (e.g. 1.2.3): GitHub release + Snapcraft/Flathub stable channels.

Follow these steps exactly:

1. Validate input

Confirm the version argument looks like X.Y.Z (semantic version, no leading v). Pre-release versions following the SemVer structure are also allowed, e.g. X.Y.Z-alpha.N or X.Y.Z-beta.N. If not provided or invalid, stop and ask the user for the correct version.

Set RELEASE_VERSION = $ARGUMENTS.

2. Create a release branch

git checkout main && git pull
git checkout -b release/v$ARGUMENTS

3. Update the version files

a. VERSION — set contents to exactly RELEASE_VERSION with a trailing newline. (meson.build and build.gradle.kts both read from this file automatically.)

b. data/io.speedofsound.SpeedOfSound.metainfo.xml.in — add a new <release> entry inside <releases>, only for stable releases (i.e. versions without a pre-release suffix like -alpha.N or -beta.N). Skip this file entirely for pre-release versions.

To build the release notes:

1. Find the most recent release tag: git describe --tags --abbrev=0
2. Get the tag date and list PRs merged since then:

   TAG_DATE=$(git for-each-ref --format='%(creatordate:short)' refs/tags/<previous-tag>)
   gh pr list --state merged --base main \
     --search "merged:>=$TAG_DATE" \
     --json number,title,body --limit 50
   

3. Read the metainfo file to understand the existing <release> format.
4. Prepend a new entry using today's date and a concise, user-facing summary derived from the PR titles and bodies.

The entry must follow this exact format (see existing entries for reference):

<release version="RELEASE_VERSION" date="YYYY-MM-DD">
    <url type="details">https://github.com/zugaldia/speedofsound/releases/tag/vRELEASE_VERSION</url>
    <description>
        <p>
            User-facing summary here.
        </p>
    </description>
</release>

4. Stage and commit

For stable releases:

git add VERSION data/io.speedofsound.SpeedOfSound.metainfo.xml.in
git commit -m "chore: release v$ARGUMENTS"

For pre-release versions (alpha/beta), omit the metainfo file:

git add VERSION
git commit -m "chore: release v$ARGUMENTS"
git push origin release/v$ARGUMENTS

5. Open a pull request

gh pr create \
  --base main \
  --title "chore: release v$ARGUMENTS" \
  --body "Release v$ARGUMENTS

- Updates \`VERSION\` to \`$ARGUMENTS\`
- Adds release notes to \`metainfo.xml.in\`"

6. Post-merge

Once the PR is merged to main, the release-dispatcher workflow runs automatically. It reads the VERSION file, creates the v$ARGUMENTS tag if it doesn't already exist, and triggers the release-* workflows to build and publish the releases. If the version contains alpha or beta, the GitHub release is automatically marked as a pre-release.

Remind the user to:

1. Monitor the workflows at: https://github.com/zugaldia/speedofsound/actions
2. Verify the release at: https://github.com/zugaldia/speedofsound/releases

Error recovery

If any step fails, do NOT retry blindly. Show the error to the user and ask how to proceed.

Source: zugaldia/speedofsound — distributed by TomeVault.