ci: bundle release notes with release artifacts

crazii · Jan 27, 2024 · 6e065a1 · 6e065a1
1 parent ca571ba
commit 6e065a1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/.github/workflows/01-build-and-release.yml b/.github/workflows/01-build-and-release.yml
@@ -39,18 +39,17 @@ jobs:
           . /opt/djgpp/setenv
           make
           test -f output/sbemu.exe
-      - name: Build FreeDOS SBEMU USB image
+      - name: Combine changelog and user instructions into release notes
+        run: |
+          cat $GITHUB_WORKSPACE/CHANGELOG.md $GITHUB_WORKSPACE/src/user_instructions.md > $GITHUB_WORKSPACE/RELEASE_NOTES.md
+      - name: Build FreeDOS SBEMU USB image and ZIP file
         run: |
           shellcheck $GITHUB_WORKSPACE/src/scripts/build-release-artifacts.sh
-          $GITHUB_WORKSPACE/src/scripts/build-release-artifacts.sh $GITHUB_WORKSPACE/src/output/sbemu.exe $GITHUB_WORKSPACE/
+          $GITHUB_WORKSPACE/src/scripts/build-release-artifacts.sh $GITHUB_WORKSPACE/src/output/sbemu.exe $GITHUB_WORKSPACE/RELEASE_NOTES.md $GITHUB_WORKSPACE/
       - name: Generate release tag
         id: tag
         run: |
           echo "release_tag=UserBuild_$(date +"%Y.%m.%d_%H-%M")" >> $GITHUB_OUTPUT
-      - name: Combine changelog and user instructions into release notes
-        run: |
-          cat $GITHUB_WORKSPACE/CHANGELOG.md $GITHUB_WORKSPACE/src/user_instructions.md > $GITHUB_WORKSPACE/RELEASE_NOTES.md
-
       - name: Release FreeDOS SBEMU USB image
         uses: softprops/action-gh-release@v1
         env:

diff --git a/scripts/build-release-artifacts.sh b/scripts/build-release-artifacts.sh
@@ -1,11 +1,18 @@
 #!/usr/bin/env bash
 set -e
+
 PATH_TO_SBEMU_EXE=${1?param 1 missing - path to SBEMU.EXE}
 test -f "$PATH_TO_SBEMU_EXE" || (echo "File $PATH_TO_SBEMU_EXE does not exit"; exit 1)
 FULL_PATH_TO_SBEMU_EXE=$(readlink -f "$PATH_TO_SBEMU_EXE")
-PATH_TO_OUTPUT_ARTIFACTS=${2?param 2 missing - path to output directory}
+
+PATH_TO_RELEASE_NOTES=${2?param 2 missing - path to RELEASE_NOTES.md}
+test -f "$PATH_TO_RELEASE_NOTES" || (echo "File $PATH_TO_RELEASE_NOTES does not exit"; exit 1)
+FULL_PATH_TO_RELEASE_NOTES=$(readlink -f "$PATH_TO_RELEASE_NOTES")
+
+PATH_TO_OUTPUT_ARTIFACTS=${3?param 3 missing - path to output directory}
 test -d "$PATH_TO_OUTPUT_ARTIFACTS" || (echo "Directory $PATH_TO_OUTPUT_ARTIFACTS does not exit"; exit 1)
 FULL_PATH_TO_OUTPUT_ARTIFACTS=$(readlink -f "$PATH_TO_OUTPUT_ARTIFACTS")
+
 mkdir -p /tmp/sbemu_usb_img
 rm -rf /tmp/sbemu_usb_img/*
 pushd /tmp/sbemu_usb_img
@@ -26,7 +33,9 @@ mkdir -p /tmp/mnt
 sudo mount FD13LITE.img /tmp/mnt -t vfat -o loop,offset=$((63*512)),rw,uid="$(id -u)",gid="$(id -g)"
 mkdir /tmp/mnt/sbemu
 cp "$FULL_PATH_TO_SBEMU_EXE" /tmp/mnt/sbemu
+cp "$FULL_PATH_TO_RELEASE_NOTES" /tmp/mnt/sbemu
 cp "$FULL_PATH_TO_SBEMU_EXE" /tmp/SBEMU
+cp "$FULL_PATH_TO_RELEASE_NOTES" /tmp/SBEMU
 pushd /tmp/mnt
 mkdir jemm
 cd jemm