Port changes from vue ecosystem ci (#256)

* feat: add a comparison column to the PR comment Co-Authored-By: Haoqun Jiang <[email protected]> * feat: updateComment -> deleteComment + createComment So that maintainers can get one more email notification when the CI is done. Co-Authored-By: Haoqun Jiang <[email protected]> * feat: swap delete comment and create comment * feat: show ref the CI ran on * fix: fix ref link * fix: set working-directory * fix: set working-directory * feat: change ref link --------- Co-authored-by: Haoqun Jiang <[email protected]>
vitejs · Oct 20, 2023 · 8fd7bf9 · 8fd7bf9
1 parent 4f4314e
commit 8fd7bf9
Showing 1 changed file with 71 additions and 11 deletions.
diff --git a/.github/workflows/ecosystem-ci-from-pr.yml b/.github/workflows/ecosystem-ci-from-pr.yml
@@ -88,6 +88,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: init
     if: "inputs.suite != '-'"
+    outputs:
+      ref: ${{ steps.get-ref.outputs.ref }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
@@ -105,12 +107,20 @@ jobs:
           --branch ${{ inputs.branchName }}
           --repo ${{ inputs.repo }}
           ${{ inputs.suite }}
+      - id: get-ref
+        if: always()
+        run: |
+          ref=$(git log -1 --pretty=format:%H)
+          echo "ref=$ref" >> $GITHUB_OUTPUT
+        working-directory: workspace/vite
 
   execute-all:
     timeout-minutes: 30
     runs-on: ubuntu-latest
     needs: init
     if: "inputs.suite == '-'"
+    outputs:
+      ref: ${{ steps.get-ref.outputs.ref }}
     strategy:
       matrix:
         suite:
@@ -157,6 +167,12 @@ jobs:
           --branch ${{ inputs.branchName }}
           --repo ${{ inputs.repo }}
           ${{ matrix.suite }}
+      - id: get-ref
+        if: always()
+        run: |
+          ref=$(git log -1 --pretty=format:%H)
+          echo "ref=$ref" >> $GITHUB_OUTPUT
+        working-directory: workspace/vite
 
   update-comment:
     runs-on: ubuntu-latest
@@ -173,6 +189,10 @@ jobs:
         with:
           github-token: ${{ steps.generate-token.outputs.token }}
           script: |
+            const mainRepoName = 'vite'
+            const ref = "${{ needs.execute-all.outputs.ref }}" || "${{ needs.execute-selected-suite.outputs.ref }}"
+            const refLink = `[\`${ref.slice(0, 7)}\`](${context.serverUrl}/${context.repo.owner}/${mainRepoName}/pull/${context.payload.inputs.prNumber}/commits/${ref})`
+
             const { data: { jobs } } = await github.rest.actions.listJobsForWorkflowRun({
               owner: context.repo.owner,
               repo: context.repo.repo,
@@ -181,20 +201,20 @@ jobs:
             });
 
             const selectedSuite = context.payload.inputs.suite
-            let result
+            let results
             if (selectedSuite !== "-") {
               const { conclusion, html_url } = jobs.find(job => job.name === "execute-selected-suite")
-              result = [{ suite: selectedSuite, conclusion, link: html_url }]
+              results = [{ suite: selectedSuite, conclusion, link: html_url }]
             } else {
-              result = jobs
+              results = jobs
                 .filter(job => job.name.startsWith('execute-all '))
                 .map(job => {
                   const suite = job.name.replace(/^execute-all \(([^)]+)\)$/, "$1")
                   return { suite, conclusion: job.conclusion, link: job.html_url }
                 })
             }
 
-            const url = `${context.serverUrl}//${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`
+            const url = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`
             const urlLink = `[Open](${url})`
 
             const conclusionEmoji = {
@@ -203,17 +223,57 @@ jobs:
               cancelled: ":stop_button:"
             }
 
+            // check for previous ecosystem-ci runs against the main branch
+
+            // first, list workflow runs for ecosystem-ci.yml
+            const { data: { workflow_runs } } = await github.rest.actions.listWorkflowRuns({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              workflow_id: 'ecosystem-ci.yml'
+            });
+
+            // for simplity, we only take the latest completed scheduled run
+            // otherwise we would have to check the inputs for every maunally triggerred runs, which is an overkill
+            const latestScheduledRun = workflow_runs.find(run => run.event === "schedule" && run.status === "completed")
+
+            // get the jobs for the latest scheduled run
+            const { data: { jobs: scheduledJobs } } = await github.rest.actions.listJobsForWorkflowRun({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              run_id: latestScheduledRun.id
+            });
+            const scheduledResults = scheduledJobs
+              .filter(job => job.name.startsWith('test-ecosystem '))
+              .map(job => {
+                const suite = job.name.replace(/^test-ecosystem \(([^)]+)\)$/, "$1")
+                return { suite, conclusion: job.conclusion, link: job.html_url }
+              })
+
             const body = `
-            📝 Ran ecosystem CI: ${urlLink}
+            📝 Ran ecosystem CI on ${refLink}: ${urlLink}
+
+            | suite | result | [latest scheduled](${latestScheduledRun.html_url}) |
+            |-------|--------|----------------|
+            ${results.map(current => {
+              const latest = scheduledResults.find(s => s.suite === current.suite) || {} // in case a new suite is added after latest scheduled
+
+              const firstColumn = current.suite
+              const secondColumn = `${conclusionEmoji[current.conclusion]} [${current.conclusion}](${current.link})`
+              const thirdColumn = `${conclusionEmoji[latest.conclusion]} [${latest.conclusion}](${latest.link})`
 
-            | suite | result |
-            |-------|--------|
-            ${result.map(r => `| [${r.suite}](${r.link}) | ${conclusionEmoji[r.conclusion]} ${r.conclusion} |`).join("\n")}
+              return `| ${firstColumn} | ${secondColumn} | ${thirdColumn} |`
+            }).join("\n")}
             `
 
-            await github.rest.issues.updateComment({
+            await github.rest.issues.createComment({
+              issue_number: context.payload.inputs.prNumber,
               owner: context.repo.owner,
-              repo: 'vite',
-              comment_id: ${{ needs.init.outputs.comment-id }},
+              repo: mainRepoName,
               body
             })
+
+            await github.rest.issues.deleteComment({
+              owner: context.repo.owner,
+              repo: mainRepoName,
+              comment_id: ${{ needs.init.outputs.comment-id }}
+            })