Merge pull request #201 from jamshale/release-improvements

Improve release notes formatting
jamshale · Apr 30, 2024 · ac7a170 · ac7a170
2 parents f7a2b0f + 54e4443
commit ac7a170
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/.github/workflows/create-release-pr.yaml b/.github/workflows/create-release-pr.yaml
@@ -317,18 +317,18 @@ jobs:
 
           # Update the release notes with the upgraded plugins
 
-          details=$(printf "Plugins upgraded this release: \n\t\t - ")
+          details=$(printf 'Plugins upgraded this release: \\n\\t\\t - ')
 
           plugin_count=${#upgraded_plugins[@]}
           for i in $(seq 0 "$(("$plugin_count" - 2))" );
           do
-              details=$(printf '%s %s \n\t\t - ' "$details" "${upgraded_plugins[$i]}")
+              details=$(printf '%s %s \\n\\t\\t - ' "$details" "${upgraded_plugins[$i]}")
           done
-          # details=$(printf '%s %s \n' "$details" "${upgraded_plugins[-1]}")
+          details=$(printf '%s %s \\n' "$details" "${upgraded_plugins[-1]}")
 
           # Replace the first occurence of ' - ' with the details
 
-          sed -i "0,/\s\-\s/s// - ${details}/" RELEASES.md
+          sed -i "0,/\s\-\s/s// - $(printf '%s ' ${details})/" RELEASES.md
 
           # Add the updated pyproject.toml and RELEASES.md files
           git add ./*pyproject.toml

diff --git a/.github/workflows/create-release.yaml b/.github/workflows/create-release.yaml
@@ -107,14 +107,14 @@ jobs:
 
           body=$(python repo_manager.py 4)
 
-          details=$(printf "Plugins upgraded this release: \n\t\t - ")
+          details=$(printf 'Plugins upgraded this release: \\n\\t\\t - ')
 
           plugin_count=${#upgraded_plugins[@]}
           for i in $(seq 0 "$(("$plugin_count" - 2))" );
           do
-              details=$(printf '%s %s \n\t\t - ' "$details" "${upgraded_plugins[$i]}")
+              details=$(printf '%s %s \\n\\t\\t - ' "$details" "${upgraded_plugins[$i]}")
           done
-          details=$(printf '%s %s \n' "$details" "${upgraded_plugins[-1]}")
+          details=$(printf '%s %s \\n' "$details" "${upgraded_plugins[-1]}")
 
           # Set the outputs