Escape for multiline github output in get-prs.py

Author: manics

.github/workflows/watch-dependencies.yaml

@@ -83,8 +83,7 @@ jobs:
         # https://trstringer.com/github-actions-multiline-strings/#option-1---string-substitution
         run: |
           pip install PyGithub
-          PR_LIST=$(./scripts/get-prs.py ${{matrix.repository}} ${{steps.local.outputs.tag}} ${{steps.latest.outputs.tag}})
-          PR_LIST="${PR_LIST//$'\n'/'%0A'}"
+          PR_LIST=$(./scripts/get-prs.py ${{matrix.repository}} ${{steps.local.outputs.tag}} ${{steps.latest.outputs.tag}} --github-action-escape)
           echo "::set-output name=prs::$PR_LIST"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -213,8 +212,7 @@ jobs:
         # https://trstringer.com/github-actions-multiline-strings/#option-1---string-substitution
         run: |
           pip install PyGithub
-          PR_LIST=$(./scripts/get-prs.py ${{matrix.github_repo}} ${{steps.local.outputs.version}} ${{steps.latest.outputs.version}})
-          PR_LIST="${PR_LIST//$'\n'/'%0A'}"
+          PR_LIST=$(./scripts/get-prs.py ${{matrix.github_repo}} ${{steps.local.outputs.version}} ${{steps.latest.outputs.version}} --github-action-escape)
           echo "::set-output name=prs::$PR_LIST"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

scripts/get-prs.py

@@ -29,6 +29,11 @@ def extract_gitref(s):
 parser.add_argument("repo", help="The repository in format user/repo")
 parser.add_argument("start", help="commit or image/chart version from which to start")
 parser.add_argument("end", help="commit or image/chart version to which to end")
+parser.add_argument(
+    "--github-action-escape",
+    action="store_true",
+    help="Escape output for GitHub Action",
+)
 
 args = parser.parse_args()
 
@@ -44,5 +49,12 @@ def extract_gitref(s):
     s = gh.search_issues("", type="pr", repo=args.repo, sha=c.sha)
     prs.update(s)
 
-for pr in sorted(prs):
-    print(f"- [#{pr.number}]({pr.html_url}) {pr.title}")
+
+pr_summaries = [
+    f"- [#{pr.number}]({pr.html_url}) {pr.title}"
+    for pr in sorted(prs, key=lambda pr: pr.number)
+]
+if args.github_action_escape:
+    print("%0A".join(pr_summaries))
+else:
+    print("\n".join(pr_summaries))