Merge pull request #58983 from m-kuhn/commentify

Isolate "post sticky comment" logic

.github/actions/post_sticky_comment/action.yml

@@ -0,0 +1,54 @@
+name: Post Sticky Comment
+description: Post a sticky comment
+inputs:
+  marker:
+    description: Unique marker
+    required: true
+    type: string
+  body:
+    description: Body
+    required: true
+    type: string
+  pr:
+    description: Pull Request Number
+    required: true
+    type: string
+
+runs:
+  using: composite
+  steps:
+    - name: Create metadata
+      uses: actions/github-script@v7
+      env:
+        BODY: ${{ inputs.body }}
+      with:
+        script: |
+          const fs = require('fs');
+          
+          try {
+            // Get inputs from the GitHub Action
+            const marker = "${{ inputs.marker }}";
+            const body = process.env.BODY; // Transfer input via env variable as it's not possible to access it directly https://github.com/actions/github-script/issues/56#issuecomment-642188313
+            const pr = ${{ inputs.pr }};
+
+            // Create the content of the JSON file
+            const content = JSON.stringify({
+              marker: marker,
+              body: body,
+              pr_number: pr
+            }, null, 2);
+            console.debug(content)
+          
+            fs.writeFileSync('comment-${{ github.job }}.json', content);
+          
+            console.log('comment.json file has been written successfully.');
+          } catch (error) {
+            core.setFailed(`Action failed with error: ${error}`);
+          }
+
+    - name: 📤 Upload data
+      uses: actions/upload-artifact@v4
+      with:
+        name: comment_artifacts-${{ github.job }}
+        path: |
+          comment-${{ github.job }}.json

.github/workflows/build_artifact_comment.yml

@@ -2,13 +2,18 @@ name: Write build artifact comments
 
 on:
   workflow_run:
-    workflows: [🪟 MingW64 Windows 64bit Build]
+    workflows: 
+      - 🪟 Workflow A
+      - 🪟 Windows Qt6
     types:
       - completed
 
 permissions:
   contents: read
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+
 jobs:
   on-success:
 
@@ -22,86 +27,128 @@ jobs:
         uses: actions/github-script@v7
         with:
           script: |
-            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+            const fs = require('fs');
+
+            const allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
                owner: context.repo.owner,
                repo: context.repo.repo,
                run_id: context.payload.workflow_run.id,
             });
+
             let matchArtifacts = allArtifacts.data.artifacts.filter((artifact) => {
-              return artifact.name == "QGIS for Windows 64bit"
+              return artifact.name.startsWith('comment_artifacts-');
             });
-            if (matchArtifacts.length>0)
+
+            if (matchArtifacts.length > 0)
             {
-              let download = await github.rest.actions.downloadArtifact({
-                 owner: context.repo.owner,
-                 repo: context.repo.repo,
-                 artifact_id: matchArtifacts[0].id,
-                 archive_format: 'zip',
-              });
-              let fs = require('fs');
-              fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/QGIS for Windows 64bit.zip`, Buffer.from(download.data));
-              core.setOutput('artifact_id', matchArtifacts[0].id);
+              for (const artifact of matchArtifacts) {
+                const suffix = artifact.name.split('comment_artifacts-')[1]; // Extract the suffix from the artifact name
+
+                // Download each matching artifact
+                let download = await github.rest.actions.downloadArtifact({
+                   owner: context.repo.owner,
+                   repo: context.repo.repo,
+                   artifact_id: artifact.id,
+                   archive_format: 'zip',
+                });
+
+                // Write each artifact to a zip file named after its suffix
+                const zipFilePath = `${process.env.GITHUB_WORKSPACE}/data-${suffix}.zip`;
+                fs.writeFileSync(zipFilePath, Buffer.from(download.data));
+                console.log(`Downloaded and saved artifact: ${artifact.name} to ${zipFilePath}`);
+              }
             }
             else
             {
               core.setOutput('artifact_id', 0);
             }
-            let matchArtifactsDebugSymbols = allArtifacts.data.artifacts.filter((artifact) => {
-              return artifact.name == "QGIS for Windows 64bit Debug Symbols"
-            });
-            if (matchArtifactsDebugSymbols.length>0)
-            {
-              core.setOutput('debug_symbols_artifact_id', matchArtifactsDebugSymbols[0].id);
-            }
-            else
-            {
-              core.setOutput('debug_symbols_artifact_id', 0);
-            }
 
       - name: 'Unzip artifact'
-        if: fromJSON(steps.download_artifact.outputs.artifact_id) > 0
         run: |
-          unzip "QGIS for Windows 64bit.zip"
-          unzip -j qgis-portable-win64.zip pr_number git_commit
+          unzip data-*.zip
 
       - name: 'Post artifact download link as comment on PR'
-        if: fromJSON(steps.download_artifact.outputs.artifact_id) > 0
         uses: actions/github-script@v7
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
-            let fs = require('fs');
-            let issue_number = Number(fs.readFileSync('./pr_number'));
-            let git_sha = String(fs.readFileSync('./git_commit')).trim();
+            function updateCommentSection(prComment, marker, body) {
+              // Create a regular expression to match the section between start and end markers
+              const sectionRegex = new RegExp(`(<!-- ====startsection ${marker}-->\\n)([\\s\\S]*?)(<!-- ====endsection ${marker}-->)`, 'm');
+              
+              // Check if the section with the marker exists
+              if (sectionRegex.test(prComment)) {
+                // Replace the existing body text between the markers
+                return prComment.replace(sectionRegex, `$1${body}\n$3`);
+              } else {
+                // If the section doesn't exist, append the new section to the end
+                return prComment.trim() + `\n\n<!-- ====startsection ${marker}-->\n${body}\n<!-- ====endsection ${marker}-->\n`;
+              }
+            }
+            const fs = require('fs');
+            const path = require('path');
+
+            // Read all files matching the pattern 'comment*.json'
+            const files = fs.readdirSync('.').filter(file => file.startsWith('comment') && file.endsWith('.json'));
+
+            if (files.length === 0) {
+              console.log('No comment*.json files found');
+              return;
+            }
+
+            // Take the PR number from the first file
+            const dataSample = JSON.parse(fs.readFileSync(files[0], 'utf8'));
+            const prNumber = dataSample.pr_number;
+
             const prComments = await github.rest.issues.listComments({
               owner: context.repo.owner,
               repo: context.repo.repo,
-              issue_number: issue_number,
+              issue_number: prNumber,
             });
-            const PREFIX = "## 🪟 Windows builds ready!";
-            let body = PREFIX + "\n\n" +
-                "Windows builds of this PR are available for testing [here](https://github.com/" + context.repo.owner + "/" + context.repo.repo + "/suites/" +  context.payload.workflow_run.check_suite_id + "/artifacts/${{steps.download_artifact.outputs.artifact_id}}).";
-            if ( ${{steps.download_artifact.outputs.debug_symbols_artifact_id}} > 0 )
-            {
-              body += " Debug symbols for this build are available [here](https://github.com/" + context.repo.owner + "/" + context.repo.repo + "/suites/" +  context.payload.workflow_run.check_suite_id + "/artifacts/${{steps.download_artifact.outputs.debug_symbols_artifact_id}}).";
+
+            const PREFIX = "<!-- !!## stickymarker ##!! -->";
+
+            // Find the comment that starts with the specified PREFIX
+            const comment = prComments.data?.find(c => c.body.startsWith(PREFIX));
+
+            let newPrComment;
+            if (!!comment) {
+                newPrComment = comment.body;
+            } else {
+                newPrComment = PREFIX + "\n";
+            }
+
+
+            // Loop through all the comment*.json files
+            for (const file of files) {
+                try {
+                    const data = JSON.parse(fs.readFileSync(file, 'utf8'));
+
+                    const marker = data.marker;
+                    const body = data.body;
+                    console.debug(data);
+
+                    newPrComment = updateCommentSection(newPrComment, marker, body);
+                } catch (error) {
+                    console.error(`Failed to process file ${file}: ${error.message}`);
+                }
             }
-            body += "\n\n*(Built from commit " + git_sha + ")*";
 
-            const winBuildComment = prComments.data?.find(c => c.body.startsWith(PREFIX));
-            if (!!winBuildComment) {
-              // update the existing comment
+            // Update or create the PR comment after processing all the files
+            if (!!comment) {
+              // Update the existing comment
               await github.rest.issues.updateComment({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
-                comment_id: winBuildComment.id,
-                body: body
+                comment_id: comment.id,
+                body: newPrComment
               });
             } else {
-              // submit a new comment
+              // Create a new comment
               await github.rest.issues.createComment({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
-                issue_number: issue_number,
-                body: body
+                issue_number: prNumber,
+                body: newPrComment
               });
             }

.github/workflows/mingw64.yml

@@ -105,12 +105,25 @@ jobs:
 
       - name: Upload QGIS for Windows 64bit
         uses: actions/upload-artifact@v4
+        id: artifact-win64
         with:
           name: QGIS for Windows 64bit
           path: qgis-portable-win64.zip
 
       - name: Upload QGIS for Windows 64bit Debug Symbols
         uses: actions/upload-artifact@v4
+        id: artifact-win64-debug
         with:
           name: QGIS for Windows 64bit Debug Symbols
           path: qgis-portable-win64-debugsym.zip
+
+      - name: Schedule download comment
+        uses: ./.github/actions/post_sticky_comment
+        with:
+          marker: mingw64
+          body: |
+            ### 🪟 Windows builds
+            Download [Windows builds of this PR for testing](${{ steps.artifact-win64.outputs.artifact-url }}).
+            Debug symbols for this build are available [here](${{ steps.artifact-win64-debug.outputs.artifact-url }}).";
+            *(Built from commit ${{ github.event.pull_request.head.sha }})*
+          pr: ${{ github.event.number }}