Merge pull request #4 from redmushie/feature/release-body

Add RELEASE.md as default release body
OpenShock · Sep 19, 2023 · c7ea03a · c7ea03a
2 parents 1ecf1c3 + 42ef272
commit c7ea03a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.github/workflows/ci-tag.yml b/.github/workflows/ci-tag.yml
@@ -31,10 +31,24 @@ jobs:
       - name: Build PlatformIO Project
         run: pio run
 
+      # This step reads a file from repo and use it for body of the release
+      # This works on any self-hosted runner OS
+      - name: Read RELEASE.md
+        id: read_release
+        shell: bash
+        run: |
+          r=$(cat RELEASE.md)                               # <--- Read release.md (Provide correct path as per your repo)
+          r="${r//'%'/'%25'}"                               # Multiline escape sequences for %
+          r="${r//$'\n'/'%0A'}"                             # Multiline escape sequences for '\n'
+          r="${r//$'\r'/'%0D'}"                             # Multiline escape sequences for '\r'
+          echo "RELEASE_BODY=$r" >> $GITHUB_OUTPUT          # <--- Set environment variable
+
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@v2
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           file: .pio/build/ShockLink/firmware.bin
           asset_name: ShockLink.bin
           tag: ${{ github.ref }}
+          body: |
+            ${{ steps.read_release.outputs.RELEASE_BODY }}  # <--- Use environment variables that was created earlier
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,3 @@
+# ShockLink Firmware
+
+Download `ShockLink.bin` and flash it to your microcontroller.