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
This commit is contained in:
Antheas Kapenekakis 2024-10-26 22:20:26 +02:00 committed by GitHub
parent af729fe863
commit 94c4761b28
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 3 deletions

View File

@ -42,10 +42,10 @@ CHANGELOG_TITLE = "{tag}: {pretty}"
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 @@ Visit [bazzite.gg](https://bazzite.gg) for more information and to download Bazz
| **[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)

View File

@ -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