From 94c4761b28013fb89b8a61009df83fba7e706452 Mon Sep 17 00:00:00 2001
From: Antheas Kapenekakis <5252246+antheas@users.noreply.github.com>
Date: Sat, 26 Oct 2024 22:20:26 +0200
Subject: [PATCH] chore(changelog): Tweak changelog with rebase command, ignore
 refs in target (#1786)

* fix: ignore refs/head/ from github.ref

* chore: update changelog text with rebase command

* fix: skip merge commits as they are not informative

* chore: reorder release text to look better truncated
---
 .github/workflows/changelog.py         | 17 +++++++++++++++--
 .github/workflows/generate_release.yml |  4 +++-
 2 files changed, 18 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/changelog.py b/.github/workflows/changelog.py
index 8051b5ae64..497b2accda 100644
--- a/.github/workflows/changelog.py
+++ b/.github/workflows/changelog.py
@@ -42,10 +42,10 @@
 CHANGELOG_FORMAT = """\
 {handwritten}
 
-From previous `{target}` version `{prev}` there have been the following changes. **One package per new version shown.**
-
 Visit [bazzite.gg](https://bazzite.gg) for more information and to download Bazzite.
 
+From previous `{target}` version `{prev}` there have been the following changes. **One package per new version shown.**
+
 ### Major packages
 | Name | Version |
 | --- | --- |
@@ -58,6 +58,15 @@
 | **[HHD](https://github.com/hhd-dev/hhd)** | {pkgrel:hhd} |
 
 {changes}
+
+### How to update
+For current users, type the following to rebase to this version:
+```bash
+# For this branch (if latest):
+bazzite-rollback-helper rebase {target}
+# For this specific image:
+bazzite-rollback-helper rebase {curr}
+```
 """
 HANDWRITTEN_PLACEHOLDER = """\
 This is an automatically generated changelog for release `{curr}`."""
@@ -287,6 +296,10 @@ def get_commits(prev_manifests, manifests, workdir: str):
             if not commit:
                 continue
             hash, short, subject = commit.split(" ", 2)
+
+            if subject.lower().startswith("merge"):
+                continue
+
             out += (
                 COMMIT_FORMAT.replace("{short}", short)
                 .replace("{subject}", subject)
diff --git a/.github/workflows/generate_release.yml b/.github/workflows/generate_release.yml
index 30374cdbd7..9530e5d473 100644
--- a/.github/workflows/generate_release.yml
+++ b/.github/workflows/generate_release.yml
@@ -22,7 +22,9 @@ jobs:
       - name: Get target
         id: get-target
         run: |
-          echo "target=${{ github.event.inputs.target || github.ref }}" > $GITHUB_OUTPUT
+          TARGET="${{ github.event.inputs.target || github.ref }}"
+          TARGET="${TARGET##*/}"
+          echo "target=$TARGET" >> $GITHUB_OUTPUT
       
       - name: Generate Release Text
         id: generate-release