Address comments and cleanup

Author: HyukjinKwon

.github/workflows/notify_test_workflow.yml

@@ -38,23 +38,34 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
-            const endpoint = "GET /repos/:owner/:repo/actions/workflows/:id/runs?&branch=:branch"
+            const endpoint = 'GET /repos/:owner/:repo/actions/workflows/:id/runs?&branch=:branch'
 
             // TODO: Should use pull_request.user and pull_request.user.repos_url?
             // If a different person creates a commit to another forked repo,
             // it wouldn't be able to detect.
             const params = {
               owner: context.payload.pull_request.head.repo.owner.login,
               repo: context.payload.pull_request.head.repo.name,
-              id: "build_and_test.yml",
+              id: 'build_and_test.yml',
               branch: context.payload.pull_request.head.ref,
             }
 
+            console.log('SHA: ' + context.payload.pull_request.head.ref)
+
+            // Wait 3 seconds to make sure the fork repository triggered a workflow.
+            await new Promise(r => setTimeout(r, 3000))
+
             const runs = await github.request(endpoint, params)
             const runID = runs.data.workflow_runs[0].id
-            const runUrl = "https://github.com/"
+            // TODO: If no workflows were found, it's likely GitHub Actions was not enabled
+
+            if (runs.data.workflow_runs[0].head_sha != context.payload.pull_request.head.sha) {
+              throw new Error('There was a new unsynced commit pushed. Please retrigger the workflow.');
+            }
+
+            const runUrl = 'https://github.com/'
               + context.payload.pull_request.head.repo.full_name
-              + "/actions/runs/"
+              + '/actions/runs/'
               + runID
 
             const name = 'Build and test'

.github/workflows/update_build_status.yml

@@ -33,32 +33,41 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
-            const endpoint = "GET /repos/:owner/:repo/pulls?state=:state"
+            const endpoint = 'GET /repos/:owner/:repo/pulls?state=:state'
             const params = {
               owner: context.repo.owner,
               repo: context.repo.repo,
               state: 'open'
             }
 
-            const maybeReady = ["clean", "has_hooks", "unknown", "unstable"];
-            const notReady = ["dirty", "draft"];
+            // See https://docs.github.com/en/graphql/reference/enums#mergestatestatus
+            const maybeReady = ['behind', 'clean', 'draft', 'has_hooks', 'unknown', 'unstable'];
 
+            // Iterate open PRs
             for await (const prs of github.paginate.iterator(endpoint,params)) {
+              // Each page
               for await (const pr of prs.data) {
+                console.log('SHA: ' + pr.head.sha)
+                console.log('  Mergeable status: ' + pr.mergeable_state)
                 if (pr.mergeable_state == null || maybeReady.includes(pr.mergeable_state)) {
                   const checkRuns = await github.request('GET /repos/{owner}/{repo}/commits/{ref}/check-runs', {
                     owner: context.repo.owner,
                     repo: context.repo.repo,
                     ref: pr.head.sha
                   })
 
+                  // Iterator GitHub Checks in the PR
                   for await (const cr of checkRuns.data.check_runs) {
-                    if (cr.name == "Build and test") {
-                      const params = JSON.parse(cr.output.text)  // text contains parameters to make request in JSON
+                    if (cr.name == 'Build and test') {
+                      // text contains parameters to make request in JSON.
+                      const params = JSON.parse(cr.output.text)
+
+                      // Get the workflow run in the forked repository
                       const run = await github.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', params)
 
                       // Keep syncing the status of the checks
-                      if (run.data.status == "completed") {
+                      if (run.data.status == 'completed') {
+                        console.log('    Run ' + cr.id + ': set status (' + run.data.status + ') and conclusion (' + run.data.conclusion + ')')
                         const response = await github.request('PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}', {
                           owner: context.repo.owner,
                           repo: context.repo.repo,
@@ -68,6 +77,7 @@ jobs:
                           conclusion: run.data.conclusion
                         })
                       } else {
+                        console.log('    Run ' + cr.id + ': set status (' + run.data.status + ')')
                         const response = await github.request('PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}', {
                           owner: context.repo.owner,
                           repo: context.repo.repo,