From acde716b862de995d2d6005ddb93db4bc3236d32 Mon Sep 17 00:00:00 2001 From: Rick Peters Date: Wed, 30 Sep 2026 13:20:22 +0200 Subject: [PATCH 1/3] feat(ci): release notes are generated: the base version, Steamify's changelog section and the commits since the previous release; the mirror's release uses the same text --- .github/workflows/iso-1-github-tag.yml | 29 ++++++++++++++++++++----- .github/workflows/iso-2-gitea-build.yml | 14 +++++++----- AGENTS.md | 5 +++++ 3 files changed, 37 insertions(+), 11 deletions(-) diff --git a/.github/workflows/iso-1-github-tag.yml b/.github/workflows/iso-1-github-tag.yml index 67f2126..1f57f1f 100644 --- a/.github/workflows/iso-1-github-tag.yml +++ b/.github/workflows/iso-1-github-tag.yml @@ -38,6 +38,8 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Tag and release env: @@ -65,17 +67,34 @@ jobs: # The ISO's file on the mirror is named after the tag (iso-2-gitea-build.yml, profiledef.sh), so its # download link is known now. file="steamify-cachyos-${tag#v}-x86_64.iso" dl="$GITEA_URL/$GITEA_REPO/releases/download/$tag" - # The Steamify section of CHANGELOG.md ("## CachyOS with Steamify Live ISO"), without its heading. - section="$(awk '/^## CachyOS with Steamify Live ISO/ {found = 1; next} found && /^#/ {exit} found' CHANGELOG.md)" + # The notes are generated, nothing is written by hand: + # - the CachyOS base version (first line of CHANGELOG.md, the fork's upstream changelog), + # - the Steamify version's own changelog section (steamify-cachyos CHANGELOG.md at the ref or tag it is built from), + # - this repository's commits since the previous release of the same kind. + base="$(head -n 1 CHANGELOG.md | sed 's/^# *//')" + steamify_notes="$(gh api "repos/theupriser/steamify-cachyos/contents/CHANGELOG.md?ref=${sref:-v$steamify}" -q .content 2> /dev/null | base64 -d 2> /dev/null | + awk -v v="$steamify" 'index($0, "## " v " ") == 1 {f = 1; next} f && /^## / {exit} f')" + [ "$kind" = release ] && want_pre=false || want_pre=true + prev="$(gh release list -L 50 --json tagName,isPrerelease,createdAt -q "[.[] | select(.isPrerelease == $want_pre and .tagName != \"$tag\")] | sort_by(.createdAt) | reverse | .[0].tagName // empty")" + if [ -n "$prev" ] && git rev-parse -q --verify "refs/tags/$prev" > /dev/null; then + changes="$(git log --no-merges --format='- %s' "$prev..HEAD" | head -n 40)"; since="since $prev" + else + changes="$(git log --no-merges --format='- %s' -n 15)"; since="(the latest commits: no earlier $kind release)" + fi + [ -n "$changes" ] || changes="- no changes since $prev" notes="![ISO build](https://img.shields.io/badge/ISO_build-running-yellow) - The ISO is built from \`$(git rev-parse --short HEAD)\` (${{ github.ref_name }}) with Steamify $steamify${sref:+ (branch $sref)} and published on the mirror (GitHub releases take at most 2 GB per file), about half an hour after this release (the mirror's sync, then the build): + CachyOS $base with Steamify $steamify${sref:+ (branch $sref)} built in: install CachyOS and turn the PC into a Steam Machine in one go. Built from \`$(git rev-parse --short HEAD)\` (${{ github.ref_name }}) and published on the mirror (GitHub releases take at most 2 GB per file), about 20 minutes after this release: **Download: [$file]($dl/$file)** ([SHA-256]($dl/$file.sha256), [release page]($GITEA_URL/$GITEA_REPO/releases/tag/$tag)) - Sources: [Steamify](https://github.com/theupriser/steamify-cachyos/tree/${sref:-v$steamify}), this repository at this tag, and the packages' sources at [CachyOS](https://github.com/CachyOS) and [Arch Linux](https://archlinux.org/packages/). + ### Steamify $steamify + ${steamify_notes:-No changelog section for this version.} - $section" + ### Changes in this ISO $since + $changes + + Sources: [Steamify](https://github.com/theupriser/steamify-cachyos/tree/${sref:-v$steamify}), this repository at this tag, and the packages' sources at [CachyOS](https://github.com/CachyOS) and [Arch Linux](https://archlinux.org/packages/)." # One ISO per day and kind: the newest build of a day replaces the earlier one (space), here and on the mirror. if git ls-remote --exit-code --tags origin "refs/tags/$tag" > /dev/null 2>&1 || gh release view "$tag" > /dev/null 2>&1; then echo "$tag exists: replacing it" diff --git a/.github/workflows/iso-2-gitea-build.yml b/.github/workflows/iso-2-gitea-build.yml index 7d79aaf..accd65f 100644 --- a/.github/workflows/iso-2-gitea-build.yml +++ b/.github/workflows/iso-2-gitea-build.yml @@ -173,15 +173,17 @@ jobs: { echo "publish=true"; echo "name=$name"; } >> "$GITHUB_OUTPUT" section="$(awk '/^## CachyOS with Steamify Live ISO/ {found = 1; next} found && /^#/ {exit} found' CHANGELOG.md)" src="${{ inputs.steamify_ref }}"; src="${src:-v$STEAMIFY_VERSION}" + # The same notes as the GitHub release (one source: iso-1 generated them), without its badge line; the + # checksum line is added here. Fallback: a short text. + if curl -fsS "https://api.github.com/repos/theupriser/steamify-cachyos-live-iso/releases/tags/$tag" -o /tmp/ghrel.json; then + jq -r '.body // ""' /tmp/ghrel.json | sed '/ISO build\]/d' > release-notes.md + else + echo "Built from \`$(git rev-parse --short HEAD)\` ($tag) with Steamify $STEAMIFY_VERSION." > release-notes.md + fi { - echo "Built from \`$(git rev-parse --short HEAD)\` ($tag) with Steamify $STEAMIFY_VERSION." echo echo "SHA-256: \`$(cut -d' ' -f1 "$iso.sha256")\`, label \`STEAMIFY_${STEAMIFY_VERSION//./_}_$b\`" - echo - echo "Sources: [Steamify](https://github.com/theupriser/steamify-cachyos/tree/$src), this repository at this tag, and the packages' sources at [CachyOS](https://github.com/CachyOS) and [Arch Linux](https://archlinux.org/packages/)." - echo - echo "$section" - } > release-notes.md + } >> release-notes.md cat release-notes.md - name: Publish ${{ github.ref_name }} diff --git a/AGENTS.md b/AGENTS.md index 263690b..dcf51e7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -139,3 +139,8 @@ Full write-up, with every trap: `steamify-iso-release` in steamify-cachyos-dev. iso-2's last job `report` (`if: always()`) replaces it with succeeded / failed / cancelled, linked to the Gitea run, through the GitHub API with the Gitea secret `GH_RELEASE_TOKEN` (fine-grained, this repo, Contents read and write). Without the secret the badge stays "running". Gitea's own badge can't show these runs (they run on a tag ref). +- **Release notes are generated, not written by hand** (iso-1): the CachyOS base version (first line of CHANGELOG.md), the + Steamify version's own changelog section (steamify-cachyos CHANGELOG.md at the ref or tag it is built from) and this + repository's commits since the previous release of the same kind (newest 40). iso-2 takes the same text from the GitHub + release for the mirror's release (one source), without the badge line, and adds the checksum line. The old hand-written + "## CachyOS with Steamify Live ISO" section in CHANGELOG.md is no longer used. From 71d429915ed9b71d7466893d8d7fc69733f68fa3 Mon Sep 17 00:00:00 2001 From: Rick Peters Date: Wed, 30 Sep 2026 13:22:47 +0200 Subject: [PATCH 2/3] feat(ci): release notes: clearer wording, workflow (ci) and docs commits left out of the ISO's change list, checksum section --- .github/workflows/iso-1-github-tag.yml | 20 +++++++++++++------- .github/workflows/iso-2-gitea-build.yml | 5 +++-- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/.github/workflows/iso-1-github-tag.yml b/.github/workflows/iso-1-github-tag.yml index 1f57f1f..0d101ef 100644 --- a/.github/workflows/iso-1-github-tag.yml +++ b/.github/workflows/iso-1-github-tag.yml @@ -76,25 +76,31 @@ jobs: awk -v v="$steamify" 'index($0, "## " v " ") == 1 {f = 1; next} f && /^## / {exit} f')" [ "$kind" = release ] && want_pre=false || want_pre=true prev="$(gh release list -L 50 --json tagName,isPrerelease,createdAt -q "[.[] | select(.isPrerelease == $want_pre and .tagName != \"$tag\")] | sort_by(.createdAt) | reverse | .[0].tagName // empty")" + # Commits that change the ISO itself: not the workflow ones (type or scope ci, e.g. ci: / fix(ci):) and not docs:. if [ -n "$prev" ] && git rev-parse -q --verify "refs/tags/$prev" > /dev/null; then - changes="$(git log --no-merges --format='- %s' "$prev..HEAD" | head -n 40)"; since="since $prev" + range="$prev..HEAD"; limit=40; since="Since \`$prev\`:" else - changes="$(git log --no-merges --format='- %s' -n 15)"; since="(the latest commits: no earlier $kind release)" + range="HEAD"; limit=12; since="The latest commits (there is no earlier $kind release to compare with):" fi - [ -n "$changes" ] || changes="- no changes since $prev" + changes="$(git log --no-merges --format='%s' "$range" | grep -Ev '^(ci|docs)(\(.*\))?:|^[a-z]+\(ci\):' | sed 's/^/- /' | head -n "$limit" || true)" + [ -n "$changes" ] || changes="- No changes to the ISO itself." notes="![ISO build](https://img.shields.io/badge/ISO_build-running-yellow) - CachyOS $base with Steamify $steamify${sref:+ (branch $sref)} built in: install CachyOS and turn the PC into a Steam Machine in one go. Built from \`$(git rev-parse --short HEAD)\` (${{ github.ref_name }}) and published on the mirror (GitHub releases take at most 2 GB per file), about 20 minutes after this release: + **CachyOS $base with Steamify $steamify${sref:+ (branch $sref)} built in.** Install CachyOS and turn the PC into a Steam Machine in one go. + + The ISO is built from \`$(git rev-parse --short HEAD)\` (${{ github.ref_name }}). It is about 3 GB, more than a GitHub release can hold (2 GB per file), so it is published on the mirror about 20 minutes after this release is created: **Download: [$file]($dl/$file)** ([SHA-256]($dl/$file.sha256), [release page]($GITEA_URL/$GITEA_REPO/releases/tag/$tag)) ### Steamify $steamify - ${steamify_notes:-No changelog section for this version.} + ${steamify_notes:-There is no changelog section for this version.} - ### Changes in this ISO $since + ### Changes in this ISO + $since $changes - Sources: [Steamify](https://github.com/theupriser/steamify-cachyos/tree/${sref:-v$steamify}), this repository at this tag, and the packages' sources at [CachyOS](https://github.com/CachyOS) and [Arch Linux](https://archlinux.org/packages/)." + ### Sources + [Steamify](https://github.com/theupriser/steamify-cachyos/tree/${sref:-v$steamify}), this repository at this tag, and the packages' sources at [CachyOS](https://github.com/CachyOS) and [Arch Linux](https://archlinux.org/packages/)." # One ISO per day and kind: the newest build of a day replaces the earlier one (space), here and on the mirror. if git ls-remote --exit-code --tags origin "refs/tags/$tag" > /dev/null 2>&1 || gh release view "$tag" > /dev/null 2>&1; then echo "$tag exists: replacing it" diff --git a/.github/workflows/iso-2-gitea-build.yml b/.github/workflows/iso-2-gitea-build.yml index accd65f..dfc7f1a 100644 --- a/.github/workflows/iso-2-gitea-build.yml +++ b/.github/workflows/iso-2-gitea-build.yml @@ -178,11 +178,12 @@ jobs: if curl -fsS "https://api.github.com/repos/theupriser/steamify-cachyos-live-iso/releases/tags/$tag" -o /tmp/ghrel.json; then jq -r '.body // ""' /tmp/ghrel.json | sed '/ISO build\]/d' > release-notes.md else - echo "Built from \`$(git rev-parse --short HEAD)\` ($tag) with Steamify $STEAMIFY_VERSION." > release-notes.md + echo "Built from \`$(git rev-parse --short HEAD)\` ($tag) with Steamify $STEAMIFY_VERSION." > release-notes.md # fallback when GitHub cannot be reached fi { echo - echo "SHA-256: \`$(cut -d' ' -f1 "$iso.sha256")\`, label \`STEAMIFY_${STEAMIFY_VERSION//./_}_$b\`" + echo "### Checksum" + echo "SHA-256 of the ISO: \`$(cut -d' ' -f1 "$iso.sha256")\` (label \`STEAMIFY_${STEAMIFY_VERSION//./_}_$b\`)." } >> release-notes.md cat release-notes.md From dac15ff9e4de4ed02767fe0592899de91eaf6a82 Mon Sep 17 00:00:00 2001 From: Rick Peters Date: Wed, 30 Sep 2026 13:23:02 +0200 Subject: [PATCH 3/3] feat(ci): release notes: wording when there is no earlier release to compare with --- .github/workflows/iso-1-github-tag.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/iso-1-github-tag.yml b/.github/workflows/iso-1-github-tag.yml index 0d101ef..6fc200d 100644 --- a/.github/workflows/iso-1-github-tag.yml +++ b/.github/workflows/iso-1-github-tag.yml @@ -75,12 +75,13 @@ jobs: steamify_notes="$(gh api "repos/theupriser/steamify-cachyos/contents/CHANGELOG.md?ref=${sref:-v$steamify}" -q .content 2> /dev/null | base64 -d 2> /dev/null | awk -v v="$steamify" 'index($0, "## " v " ") == 1 {f = 1; next} f && /^## / {exit} f')" [ "$kind" = release ] && want_pre=false || want_pre=true + [ "$kind" = release ] && kind_name="real release" || kind_name="dev build" prev="$(gh release list -L 50 --json tagName,isPrerelease,createdAt -q "[.[] | select(.isPrerelease == $want_pre and .tagName != \"$tag\")] | sort_by(.createdAt) | reverse | .[0].tagName // empty")" # Commits that change the ISO itself: not the workflow ones (type or scope ci, e.g. ci: / fix(ci):) and not docs:. if [ -n "$prev" ] && git rev-parse -q --verify "refs/tags/$prev" > /dev/null; then range="$prev..HEAD"; limit=40; since="Since \`$prev\`:" else - range="HEAD"; limit=12; since="The latest commits (there is no earlier $kind release to compare with):" + range="HEAD"; limit=12; since="The latest commits (there is no earlier $kind_name to compare with):" fi changes="$(git log --no-merges --format='%s' "$range" | grep -Ev '^(ci|docs)(\(.*\))?:|^[a-z]+\(ci\):' | sed 's/^/- /' | head -n "$limit" || true)" [ -n "$changes" ] || changes="- No changes to the ISO itself."