Fix generating comment about new DB revisions

Author: ThiefMaster

.github/workflows/migration-sql-comment.yml

@@ -42,13 +42,11 @@ jobs:
         id: get-data
         run: |
           echo "pull_id=$(</tmp/migration-sql-data/pull-request-id)" >> $GITHUB_OUTPUT
-          if [ -f /tmp/migration-sql-data/upgrade.sql ]; then
-            sql_command=$(</tmp/migration-sql-data/upgrade.sql)
-            if [ ! -z "$sql_command" ] ; then
-              echo "sql=$sql_command" >> $GITHUB_OUTPUT
-            fi
+          if [ -s </tmp/migration-sql-data/comment.md ]; then
+              echo "has_data=true" >> $GITHUB_OUTPUT
+          else
+              echo "has_data=false" >> $GITHUB_OUTPUT
           fi
-
       - name: Find previous comment
         uses: peter-evans/find-comment@v3
         id: find-comment
@@ -59,24 +57,15 @@ jobs:
 
       - name: Create comment
         uses: peter-evans/create-or-update-comment@v4
-        if: steps.get-data.outputs.sql
+        if: steps.get-data.outputs.has_data
         with:
           issue-number: ${{ steps.get-data.outputs.pull_id }}
           comment-id: ${{ steps.find-comment.outputs.comment-id }}
           edit-mode: replace
-          body: |
-            This PR contains database changes. Before merging it, make sure to apply the migration in production:
-
-            ```sql
-            ${{ steps.get-data.outputs.sql }}
-            ```
-
-            When reviewing the PR, make sure that the changes will not break the previously deployed
-            version, i.e. any new column needs to have a `server_default` or be nullable.
-
+          body-file: /tmp/migration-sql-data/comment.md
       - name: Delete comment
         uses: peter-evans/create-or-update-comment@v4
-        if: steps.find-comment.outputs.comment-id && !steps.get-data.outputs.sql
+        if: steps.find-comment.outputs.comment-id && !steps.get-data.outputs.has_data
         with:
           issue-number: ${{ steps.get-data.outputs.pull_id }}
           comment-id: ${{ steps.find-comment.outputs.comment-id }}

.github/workflows/migration-sql.yml

@@ -56,7 +56,7 @@ jobs:
         run: |
           first_migration=$(echo '${{ steps.get-changed-files.outputs.files_created }}' | jq -r '.[0] // empty')
           latest_migration=$(echo '${{ steps.get-changed-files.outputs.files_created }}' | jq -r '.[-1] // empty')
-          ./ci/print_revision_sql.sh $first_migration $latest_migration > /tmp/migration-sql-data/upgrade.sql
+          ./ci/print_revision_sql.sh $first_migration $latest_migration > /tmp/migration-sql-data/comment.md
 
       - name: Create artifact
         uses: actions/upload-artifact@v4

ci/print_revision_sql.sh

@@ -1,20 +1,28 @@
 #!/bin/bash
 # Get all the SQL queries from the first migration file to the last, in order
-# and print them with escaped newlines
+# and print them surrounded by a markdown comment for github
 set -e
 
-
 migration_file=$1
 latest_migration=$2
 
-if [ ! -z ${migration_file} ] && [ ! -z ${latest_migration} ]; then 
-    down_revision=$(grep -Po "(?<=^down_revision = ').*(?=')" $migration_file )
-    revision=$(grep -Po "(?<=^revision = ').*(?=')" $latest_migration )
+if [ ! -z ${migration_file} ] && [ ! -z ${latest_migration} ]; then
+    down_revision=$(grep -Po "(?<=^down_revision = ').*(?=')" $migration_file)
+    revision=$(grep -Po "(?<=^revision = ').*(?=')" $latest_migration)
+
     sql_command=$(flask db upgrade --sql ${down_revision}:${revision})
-    sql_command="${sql_command//'%'/'%25'}"
-    sql_command="${sql_command//$'\n'/'%0A'}"
-    sql_command="${sql_command//$'\r'/'%0D'}" 
-    echo $sql_command
-else 
+    [ -z "$sql_command" ] && exit 0
+
+    cat << EOF
+This PR contains database changes. Before merging it, make sure to apply the migration in production:
+
+\`\`\`sql
+${sql_command}
+\`\`\`
+
+When reviewing the PR, make sure that the changes will not break the previously deployed
+version, i.e. any new column needs to have a \`server_default\` or be nullable.
+EOF
+else
     exit 0
 fi