Changed escaping and made description update optional (#75)

Co-authored-by: Chris Kaiser <chris.kaiser@bahmut.de>

Author: MasterOfGrey

.github/workflows/build-release.yml

@@ -21,6 +21,15 @@ on:
           - 'Urban Synergy Unleashed;3371689443'
           - 'USU LLWA;3387021675'
           - 'USU Morgenrote;3371690718'
+      update-description:
+          description: 'Update description?'
+          required: true
+          default: 'true'
+          type: choice
+          options:
+              - 'true'
+              - 'false'
+      
 
 jobs:
   release:
@@ -42,15 +51,26 @@ jobs:
           rm -f "${{ steps.metadata.outputs.mod-name }}/vic3-tiger.conf"
           rm -f "${{ steps.metadata.outputs.mod-name }}/design_notes.txt"
         # Use rm -f for files and rm -rf for folders.
-
+          
         # Create mod metadata for the steam release
         # Uses STEAM_PAGE.bbcode to update steam description
+      - name: Create Workshop Metadata with Description
+        if: ${{ inputs.update-description == 'true' }}
+        shell: bash
+        run: |
+            ./script/create-release-vdf.sh "${{ github.workspace }}/${{ steps.metadata.outputs.mod-name }}" "${{ steps.metadata.outputs.mod-id }}" ../steam-release/STEAM_PAGE.bbcode
+            
+      - name: Create Workshop Metadata without Description
+        if: ${{ inputs.update-description == 'false' }}
+        shell: bash
+        run: |
+            ./script/create-release-vdf.sh "${{ github.workspace }}/${{ steps.metadata.outputs.mod-name }}" "${{ steps.metadata.outputs.mod-id }}"
+            
         # Report: Generated metadata
-      - name: Create Workshop Metadata
+      - name: Process Workshop Metadata
         id: steam-metadata
         shell: bash
         run: |
-          ./script/create-release-vdf.sh "${{ github.workspace }}/${{ steps.metadata.outputs.mod-name }}" ../steam-release/STEAM_PAGE.bbcode "${{ steps.metadata.outputs.mod-id }}"
           mv workshop.vdf ../steam-release/workshop.vdf
           echo "vdf=$(realpath ../steam-release/workshop.vdf)" >> "$GITHUB_OUTPUT"
           echo "# Workflow Metadata" >> $GITHUB_STEP_SUMMARY

script/create-release-vdf.sh

@@ -10,30 +10,24 @@ else
   printf 'Usage: ./create-release-vdf.sh MOD_DIR DESC_FILE [MOD_ID]'
   exit 1
 fi
-# Check mod description
-if [ -f "$2" ]
-then
-  description="$(cat < "$2")"
-  description=${description//$'\n'/\\n}
-  description=${description//$'\t'/\\t}
-  description=${description//\"/\\\"}
-else
-  printf 'Missing Steam description'
-  printf '\n'
-  printf 'Usage: ./create-release-vdf.sh MOD_DIR DESC_FILE [MOD_ID]'
-  exit 1
-fi
 
 title=$(grep -Po '(?<=\s\"name\"\s:\s\").+(?=\",)' "$mod_path/.metadata/metadata.json")
 
 # Read mod id
-if [ -n "$3" ]
+if [ -n "$2" ]
 then
-  mod_id="$3"
+  mod_id="$2"
 else
   mod_id='0'
 fi
 
+# Check mod description
+if [ -f "$3" ]
+then
+  description="$(cat < "$3")"
+  description=${description//\"/\\\"}
+fi
+
 # Clean up old file
 printf '' > workshop.vdf
 
@@ -51,8 +45,11 @@ printf '\t"previewfile" "%s/thumbnail.png"' "$mod_path" >> workshop.vdf
 printf '\n' >> workshop.vdf
 printf '\t"title" "%s"' "$title" >> workshop.vdf
 printf '\n' >> workshop.vdf
-printf '\t"description" "%s"' "$description" >> workshop.vdf
-printf '\n' >> workshop.vdf
+if [ -f "$3" ]
+then
+	printf '\t"description" "%s"' "$description" >> workshop.vdf
+	printf '\n' >> workshop.vdf
+fi
 printf '}' >> workshop.vdf
 
 cat workshop.vdf