Actually escape the release summary better

esphome · Sep 13, 2024 · 457df8a · 457df8a
1 parent 6e7603c
commit 457df8a
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -42,7 +42,7 @@ jobs:
           version: ${{ matrix.esphome-version }}
           platform: linux/amd64
           cache: true
-          release-summary: 'Test "release" summary'
+          release-summary: 'Test "release" summary\r\n* Multiple lines'
           release-url: "https://github.com/esphome/build-action"
           complete-manifest: ${{ matrix.manifest == 'complete' }}
       - name: Write version to file

diff --git a/action.yml b/action.yml
@@ -97,6 +97,10 @@ runs:
       shell: bash
       id: build-step
       run: |-
+        read -r -d '' summary <<'ENDOFSUMMARY'
+        ${{ inputs.release-summary }}
+        ENDOFSUMMARY
+
         docker run --rm \
           --platform ${{ inputs.platform }} \
           --workdir /github/workspace \
@@ -105,7 +109,7 @@ runs:
           -e HOME \
           esphome:${{ inputs.version }} \
             ${{ inputs.yaml-file }} \
-            --release-summary ${{ toJSON(inputs.release-summary) }} \
+            --release-summary "$summary" \
             --release-url "${{ inputs.release-url }}" \
             --outputs-file "$GITHUB_OUTPUT" \
             ${{ inputs.complete-manifest == 'true' && '--complete-manifest' || '--partial-manifest' }}

diff --git a/tests/complete-manifest-template.json b/tests/complete-manifest-template.json
@@ -9,7 +9,7 @@
       "ota": {
         "path": "test-esp32.ota.bin",
         "md5": "\($md5)",
-        "summary": "Test \"release\" summary",
+        "summary": "Test \"release\" summary\r\n* Multiple lines",
         "release_url": "https://github.com/esphome/build-action"
       },
       "parts": [

diff --git a/tests/partial-manifest-template.json b/tests/partial-manifest-template.json
@@ -3,7 +3,7 @@
   "ota": {
     "path": "test-esp32.ota.bin",
     "md5": "\($md5)",
-    "summary": "Test \"release\" summary",
+    "summary": "Test \"release\" summary\r\n* Multiple lines",
     "release_url": "https://github.com/esphome/build-action"
   },
   "parts": [