From 6c8afabedfcd5f2420158710e60ecc3b48660a0d Mon Sep 17 00:00:00 2001 From: Michael Keller Date: Wed, 10 Jan 2024 09:11:51 +1300 Subject: [PATCH] CICD: Improve the Release Note Generation Use .md suffix to get the files displayed as markdown. Ignore generated artefacts. Signed-off-by: Michael Keller --- .github/workflows/post-releasenotes.yml | 2 +- .gitignore | 1 + gh_release_notes_bottom => gh_release_notes_bottom.md | 0 gh_release_notes_top => gh_release_notes_top.md | 0 scripts/create-releasenotes.sh | 8 ++++---- 5 files changed, 6 insertions(+), 5 deletions(-) rename gh_release_notes_bottom => gh_release_notes_bottom.md (100%) rename gh_release_notes_top => gh_release_notes_top.md (100%) mode change 100644 => 100755 scripts/create-releasenotes.sh diff --git a/.github/workflows/post-releasenotes.yml b/.github/workflows/post-releasenotes.yml index 723e461c5..42f4565c2 100644 --- a/.github/workflows/post-releasenotes.yml +++ b/.github/workflows/post-releasenotes.yml @@ -32,5 +32,5 @@ jobs: repository: subsurface/nightly-builds token: ${{ secrets.NIGHTLY_BUILDS }} prerelease: false - files: gh_release_notes + files: gh_release_notes.md body_path: gh_release_notes diff --git a/.gitignore b/.gitignore index b22414b26..ce8a5bed8 100644 --- a/.gitignore +++ b/.gitignore @@ -47,3 +47,4 @@ packaging/ios/Qt packaging/ios/asset_catalog_compiler.Info.plist appdata/subsurface.appdata.xml android-mobile/Roboto-Regular.ttf +gh_release_notes.md diff --git a/gh_release_notes_bottom b/gh_release_notes_bottom.md similarity index 100% rename from gh_release_notes_bottom rename to gh_release_notes_bottom.md diff --git a/gh_release_notes_top b/gh_release_notes_top.md similarity index 100% rename from gh_release_notes_top rename to gh_release_notes_top.md diff --git a/scripts/create-releasenotes.sh b/scripts/create-releasenotes.sh old mode 100644 new mode 100755 index 0f94dd992..1a81b29fe --- a/scripts/create-releasenotes.sh +++ b/scripts/create-releasenotes.sh @@ -6,7 +6,7 @@ json=$(gh pr list -s merged -S "$1" --json title,number,url) -cp gh_release_notes_top gh_release_notes +cp gh_release_notes_top.md gh_release_notes.md if [[ $json != "[]" ]]; then ( echo -n 'This build was created by [merging pull request ' @@ -16,11 +16,11 @@ if [[ $json != "[]" ]]; then echo -n ')](' echo -n $json | jq -j '.[0]|{url}|join(" ")' echo ' )' -) >> gh_release_notes +) >> gh_release_notes.md else ( echo "This build was created by directly pushing to the Subsurface repo." echo "The latest commit was [$(git log --pretty=format:"%an: '%s'" -n1)](https://github.com/subsurface/subsurface/commit/$1 )" -) >> gh_release_notes +) >> gh_release_notes.md fi -cat gh_release_notes_bottom >> gh_release_notes +cat gh_release_notes_bottom.md >> gh_release_notes.md