ci: Report changed pages

Author: tdgroot

.github/workflows/deploy.yaml

@@ -48,7 +48,9 @@ jobs:
     if: github.ref != 'refs/heads/master'
     container: quay.io/hypernode/deploy:3-php8.1-node18
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: download build artifact
         uses: actions/download-artifact@v3
         with:
@@ -65,11 +67,31 @@ jobs:
       - name: Get brancher hostname
         id: get_brancher_hostname
         run: echo "BRANCHER_URL=https://$(jq .hostnames[0] deployment-report.json -r)" >> $GITHUB_OUTPUT
+      - name: Get changed pages
+        id: changed_pages
+        run: |
+          git config --global --add safe.directory $(pwd)
+          commits=${{ github.event.pull_request.commits }}
+          if [[ -n "$commits" ]]; then
+            # Prepare enough depth for diffs with target branch
+            git fetch --depth="$(( commits + 1 ))"
+          fi
+          result="$(python3 ci/bin/get_changed_urls.py \
+            ${{ github.event.pull_request.base.sha }} \
+            ${{github.event.pull_request.head.sha}} \
+            --base-url=${{ steps.get_brancher_hostname.outputs.BRANCHER_URL }}
+          )"
+          echo "$result"
+          echo "CHANGED_PAGES<<EOF" >> $GITHUB_OUTPUT
+          echo "$result" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+        shell: bash
       - name: Comment hostname on PR
         uses: thollander/actions-comment-pull-request@v1
         with:
           message: |
-            Acceptance server is available at ${{ steps.get_brancher_hostname.outputs.BRANCHER_URL }}
+            Acceptance server is available at ${{ steps.get_brancher_hostname.outputs.BRANCHER_URL }}.
+            ${{ steps.changed_pages.outputs.CHANGED_PAGES }}
 
   deploy_production:
     needs: build
@@ -81,7 +103,7 @@ jobs:
     if: github.ref == 'refs/heads/master'
     container: quay.io/hypernode/deploy:3-php8.1-node18
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: download build artifact
         uses: actions/download-artifact@v3
         with:

ci/bin/get_changed_urls.py

@@ -0,0 +1,46 @@
+import argparse
+import re
+import subprocess
+from typing import Tuple
+
+CHANGED_PATTERN = re.compile(r"^[AM]")
+
+
+def parse_args() -> Tuple[str, str, str]:
+    parser = argparse.ArgumentParser()
+    parser.add_argument("start_commit")
+    parser.add_argument("end_commit")
+    parser.add_argument("--base-url", default="")
+
+    args = parser.parse_args()
+
+    return args.start_commit, args.end_commit, args.base_url.rstrip("/")
+
+
+def main():
+    start_commit, end_commit, base_url = parse_args()
+    diff_command = [
+        "git",
+        "diff",
+        "--name-status",
+        "-M",
+        "--stat",
+        start_commit,
+        end_commit,
+    ]
+    output = subprocess.check_output(diff_command, encoding="utf-8")
+    changed_files = filter(CHANGED_PATTERN.match, output.splitlines())
+    changed_files = map(lambda x: x.split("\t")[1], changed_files)
+    changed_markdown_files = filter(lambda x: x.endswith(".md"), changed_files)
+    changed_markdown_files = list(changed_markdown_files)
+
+    if changed_markdown_files:
+        print("Changed pages:")
+        for file in changed_markdown_files:
+            file = re.sub("^docs/", "", file)
+            file = re.sub(".md$", ".html", file)
+            print("- " + base_url + "/" + file)
+
+
+if __name__ == "__main__":
+    main()