[ci] Upload PR results always to new URLs

Otherwise, one might only see the cached versions
and not the updated results.

Refs pmd#5556

Author: adangel

.github/workflows/publish-pull-requests.yml

@@ -55,8 +55,8 @@ jobs:
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_PMD_PULL_REQUESTS_SECRET_ACCESS_KEY }}
           AWS_DEFAULT_REGION: eu-central-1
         run: |
-          aws s3 sync docs-artifact "s3://pmd-pull-requests/pr-${PR_NUMBER}/docs" --no-progress
-          echo "public url: https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/docs"
+          aws s3 sync docs-artifact "s3://pmd-pull-requests/pr-${PR_NUMBER}/${PR_SHA}/docs" --no-progress
+          echo "public url: https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/${PR_SHA}/docs"
       - name: Add commit status (Documentation)
         env:
           # Token required for GH CLI:
@@ -67,7 +67,7 @@ jobs:
             -H "Accept: application/vnd.github+json" \
             -H "X-GitHub-Api-Version: 2022-11-28" \
             "/repos/pmd/pmd/statuses/${PR_SHA}" \
-            -f "state=success" -f "target_url=https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/docs" \
+            -f "state=success" -f "target_url=https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/${PR_SHA}/docs" \
             -f "description=PMD Documentation Preview" -f "context=Published Results / Documentation"
       - name: Add Check Status (Documentation)
         env:
@@ -82,7 +82,7 @@ jobs:
             /repos/pmd/pmd/check-runs \
             -f "name=Documentation" -f "head_sha=${PR_SHA}" -f "status=completed" \
             -f "started_at=${timestamp}" -f "conclusion=success" -f "completed_at=${timestamp}" \
-            -f "output[title]=Documentation Preview" -f "output[summary]=[Documentation Preview](https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/docs)"
+            -f "output[title]=Documentation Preview" -f "output[summary]=[Documentation Preview](https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/${PR_SHA}/docs)"
 
       - name: Download pmd-regression-tester
         env:
@@ -100,8 +100,8 @@ jobs:
           AWS_DEFAULT_REGION: eu-central-1
         run: |
           if [ -e "pmd-regression-tester/index.html" ]; then
-            aws s3 sync pmd-regression-tester "s3://pmd-pull-requests/pr-${PR_NUMBER}/regression" --no-progress
-            echo "public url: https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/regression"
+            aws s3 sync pmd-regression-tester "s3://pmd-pull-requests/pr-${PR_NUMBER}/${PR_SHA}/regression" --no-progress
+            echo "public url: https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/${PR_SHA}/regression"
             echo "REGRESSION_REPORT_UPLOADED=1" >> "${GITHUB_ENV}"
           else
             echo "No report available."
@@ -118,7 +118,7 @@ jobs:
             -H "Accept: application/vnd.github+json" \
             -H "X-GitHub-Api-Version: 2022-11-28" \
             "/repos/pmd/pmd/statuses/${PR_SHA}" \
-            -f "state=success" -f "target_url=https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/regression" \
+            -f "state=success" -f "target_url=https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/${PR_SHA}/regression" \
             -f "description=PMD Regression Tester Report" -f "context=Published Results / Regression Tester"
       - name: Prepare regression summary
         run: |-
@@ -127,7 +127,7 @@ jobs:
             summary="
           ${summary}
 
-          [Regression Tester Report](https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/regression)
+          [Regression Tester Report](https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/${PR_SHA}/regression)
           "
           fi
           echo "${summary}" > pmd-regression-tester/summary.txt
@@ -153,7 +153,7 @@ jobs:
       - name: Prepare comment text
         run: |-
           summary="$(cat pmd-regression-tester/summary.txt)"
-          comment="[Documentation Preview](https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/docs)
+          comment="[Documentation Preview](https://pull-requests.pmd-code.org/pr-${PR_NUMBER}/${PR_SHA}/docs)
           
           ${summary}
           "

docs/pages/pmd/devdocs/github_actions_workflows.md

@@ -75,9 +75,11 @@ a commit status and check status to the PR and finally adds a PR comment.
 Both the "docs-artifact" and the "pmd-regression-tester" artifact are uploaded to an AWS S3 bucket
 called **pmd-pull-requests**. This bucket is served via AWS Cloudfront (for having TLS) under
 the URL <https://pull-requests.pmd-code.org>. Note, there is no directory listing. The results
-of each pull request are uploaded under the folder "pr-{PR_NUMBER}/docs" and "pr-{PR_NUMBER}/regression",
+of each pull request are uploaded under the folders "pr-{PR_NUMBER}/{PR_SHA}/docs" and "pr-{PR_NUMBER}/{PR_SHA}/regression",
 respectively. The data in the S3 bucket is available for 60 days, after that the files are removed
-(hopefully).
+automatically (hopefully). Since the head SHA of the PR is included in the URL, an updated PR will upload
+new versions of the artifacts. Otherwise, Cloudfront's cache might prevent us from seeing the
+updated artifacts.
 
 In order to upload the files to AWS S3, we use the [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/index.html)
 tool, that is available on the GitHub provided runners for GitHub Actions. It needs the following **secrets**: