[CI] Update comment trigger tests with improved workflow design (#1103)

mtfishman · web-flow · commit 3f2ab603dee1 · 2023-03-24T09:23:16.000-04:00
* Improved workflow runs on the PR commit instead of the main commit, and reports results to the PR with comments and status updates. * Based on: https://dev.to/zirkelc/trigger-github-workflow-for-comment-on-pull-request-45l2
diff --git a/.github/workflows/comment_trigger_test_itensorgaussianmps.yml b/.github/workflows/comment_trigger_test_itensorgaussianmps.yml
@@ -1,14 +1,13 @@
 name: Run ITensorGaussianMPS tests from comment trigger
 
 on:
-  pull_request:
-    types: [opened]
   issue_comment:
     types: [created]
 
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ matrix.threads }} thread(s)
+    if: github.event.issue.pull_request && contains(github.event.comment.body, '[test ITensorGaussianMPS]')
     runs-on: ${{ matrix.os }}
     env:
       JULIA_NUM_THREADS: ${{ matrix.threads }}
@@ -20,32 +19,59 @@ jobs:
         os:
           - ubuntu-latest
         threads:
-          - '1'
+          - '2'
         arch:
           - x64
     steps:
-      - name: Pull Request Comment Trigger
-        uses: Khan/pull-request-comment-trigger@v1.1.0
-        id: check
+      - name: Get PR branch
+        uses: xt0rted/pull-request-comment-branch@v1
+        id: comment-branch
+      - name: Set latest commit status as pending
+        uses: myrotvorets/set-commit-status-action@master
+        with:
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: pending
+      - name: Checkout PR branch
+        uses: actions/checkout@v3
         with:
-          trigger: '[gaussianmps]'
-          reaction: rocket
-        env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
-      - uses: actions/checkout@v2
-        if: steps.check.outputs.triggered == 'true'
+          ref: ${{ steps.comment-branch.outputs.head_ref }}
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
       - uses: julia-actions/setup-julia@latest
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-        if: steps.check.outputs.triggered == 'true'
       - name: Install Julia dependencies
         shell: julia --project=monorepo {0}
         run: |
           using Pkg;
           pkg"dev ./NDTensors . ./ITensorGaussianMPS"
-        if: steps.check.outputs.triggered == 'true'
       - name: Run the tests
-        run: >
+        run: |
           julia --project=monorepo --depwarn=yes -e 'using Pkg; Pkg.test("ITensorGaussianMPS")'
-        if: steps.check.outputs.triggered == 'true'
+      - name: Set latest commit status as ${{ job.status }}
+        uses: myrotvorets/set-commit-status-action@master
+        if: always()
+        with:
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+      - name: Add comment to PR
+        uses: actions/github-script@v6
+        if: always()
+        with:
+          script: |
+            const name = '${{ github.workflow   }}';
+            const url = '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}';
+            const success = '${{ job.status }}' === 'success';
+            const body = `${name}: ${success ? 'succeeded ✅' : 'failed ❌'}\n${url}`;
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: body
+            })
diff --git a/.github/workflows/comment_trigger_test_itensorglmakie.yml b/.github/workflows/comment_trigger_test_itensorglmakie.yml
@@ -1,14 +1,13 @@
 name: Run ITensorGLMakie tests from comment trigger
 
 on:
-  pull_request:
-    types: [opened]
   issue_comment:
     types: [created]
 
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ matrix.threads }} thread(s)
+    if: github.event.issue.pull_request && contains(github.event.comment.body, '[test ITensorGLMakie]')
     runs-on: ${{ matrix.os }}
     env:
       JULIA_NUM_THREADS: ${{ matrix.threads }}
@@ -20,25 +19,31 @@ jobs:
         os:
           - ubuntu-20.04 # Needed for proper CI installation?
         threads:
-          - '1'
+          - '2'
         arch:
           - x64
     steps:
-      - name: Pull Request Comment Trigger
-        uses: Khan/pull-request-comment-trigger@v1.1.0
-        id: check
+      - name: Get PR branch
+        uses: xt0rted/pull-request-comment-branch@v1
+        id: comment-branch
+      - name: Set latest commit status as pending
+        uses: myrotvorets/set-commit-status-action@master
         with:
-          trigger: '[glmakie]'
-          reaction: rocket
-        env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
-      - uses: actions/checkout@v2
-        if: steps.check.outputs.triggered == 'true'
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: pending
+      - name: Checkout PR branch
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ steps.comment-branch.outputs.head_ref }}
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
       - uses: julia-actions/setup-julia@latest
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-        if: steps.check.outputs.triggered == 'true'
       - uses: actions/cache@v1
         env:
           cache-name: cache-artifacts
@@ -49,16 +54,35 @@ jobs:
             ${{ runner.os }}-test-${{ env.cache-name }}-
             ${{ runner.os }}-test-
             ${{ runner.os }}-
-        if: steps.check.outputs.triggered == 'true'
       - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
-        if: steps.check.outputs.triggered == 'true'
       - name: Install Julia dependencies
         shell: julia --project=monorepo {0}
         run: |
           using Pkg;
           pkg"dev ./NDTensors . ./ITensorVisualizationBase ./ITensorMakie ./ITensorGLMakie"
-        if: steps.check.outputs.triggered == 'true'
       - name: Run the tests
         run: |
           DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=monorepo --depwarn=yes -e 'using Pkg; Pkg.test("ITensorGLMakie")'
-        if: steps.check.outputs.triggered == 'true'
+      - name: Set latest commit status as ${{ job.status }}
+        uses: myrotvorets/set-commit-status-action@master
+        if: always()
+        with:
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+      - name: Add comment to PR
+        uses: actions/github-script@v6
+        if: always()
+        with:
+          script: |
+            const name = '${{ github.workflow   }}';
+            const url = '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}';
+            const success = '${{ job.status }}' === 'success';
+            const body = `${name}: ${success ? 'succeeded ✅' : 'failed ❌'}\n${url}`;
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: body
+            })
diff --git a/.github/workflows/comment_trigger_test_itensors_mps.yml b/.github/workflows/comment_trigger_test_itensors_mps.yml
@@ -1,14 +1,13 @@
 name: Run ITensors mps tests from comment trigger
 
 on:
-  pull_request:
-    types: [opened]
   issue_comment:
     types: [created]
 
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ matrix.threads }} thread(s)
+    if: github.event.issue.pull_request && contains(github.event.comment.body, '[test ITensors mps]')
     runs-on: ${{ matrix.os }}
     env:
       JULIA_NUM_THREADS: ${{ matrix.threads }}
@@ -23,39 +22,62 @@ jobs:
           - '2'
         arch:
           - x64
-        exclude:
-          # MacOS not available on x86
-          - {os: 'macOS-latest', arch: 'x86'}
     steps:
-      - name: Pull Request Comment Trigger
-        uses: Khan/pull-request-comment-trigger@v1.1.0
-        id: check
+      - name: Get PR branch
+        uses: xt0rted/pull-request-comment-branch@v1
+        id: comment-branch
+      - name: Set latest commit status as pending
+        uses: myrotvorets/set-commit-status-action@master
         with:
-          trigger: '[mps]'
-          reaction: rocket
-        env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
-      - uses: actions/checkout@v2
-        if: steps.check.outputs.triggered == 'true'
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: pending
+      - name: Checkout PR branch
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ steps.comment-branch.outputs.head_ref }}
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
       - uses: julia-actions/setup-julia@latest
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-        if: steps.check.outputs.triggered == 'true'
       - name: Install Julia dependencies
         shell: julia --project=monorepo {0}
         run: |
           using Pkg;
           pkg"dev ./NDTensors ."
-        if: steps.check.outputs.triggered == 'true'
       - name: Run the tests
         shell: julia --project=monorepo {0}
         run: |
           using Pkg;
           # https://github.com/JuliaLang/Pkg.jl/pull/1226
           Pkg.test("ITensors"; coverage=true, test_args=["mps"])
-        if: steps.check.outputs.triggered == 'true'
       - uses: julia-actions/julia-uploadcodecov@latest
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-        if: steps.check.outputs.triggered == 'true'
+      - name: Set latest commit status as ${{ job.status }}
+        uses: myrotvorets/set-commit-status-action@master
+        if: always()
+        with:
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+      - name: Add comment to PR
+        uses: actions/github-script@v6
+        if: always()
+        with:
+          script: |
+            const name = '${{ github.workflow   }}';
+            const url = '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}';
+            const success = '${{ job.status }}' === 'success';
+            const body = `${name}: ${success ? 'succeeded ✅' : 'failed ❌'}\n${url}`;
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: body
+            })
diff --git a/.github/workflows/comment_trigger_test_itensorunicodeplots.yml b/.github/workflows/comment_trigger_test_itensorunicodeplots.yml
@@ -1,14 +1,13 @@
 name: Run ITensorUnicodePlots tests from comment trigger
 
 on:
-  pull_request:
-    types: [opened]
   issue_comment:
     types: [created]
 
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ matrix.threads }} thread(s)
+    if: github.event.issue.pull_request && contains(github.event.comment.body, '[test ITensorUnicodePlots]')
     runs-on: ${{ matrix.os }}
     env:
       JULIA_NUM_THREADS: ${{ matrix.threads }}
@@ -20,32 +19,59 @@ jobs:
         os:
           - ubuntu-latest
         threads:
-          - '1'
+          - '2'
         arch:
           - x64
     steps:
-      - name: Pull Request Comment Trigger
-        uses: Khan/pull-request-comment-trigger@v1.1.0
-        id: check
+      - name: Get PR branch
+        uses: xt0rted/pull-request-comment-branch@v1
+        id: comment-branch
+      - name: Set latest commit status as pending
+        uses: myrotvorets/set-commit-status-action@master
+        with:
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: pending
+      - name: Checkout PR branch
+        uses: actions/checkout@v3
         with:
-          trigger: '[unicodeplots]'
-          reaction: rocket
-        env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
-      - uses: actions/checkout@v2
-        if: steps.check.outputs.triggered == 'true'
+          ref: ${{ steps.comment-branch.outputs.head_ref }}
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
       - uses: julia-actions/setup-julia@latest
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-        if: steps.check.outputs.triggered == 'true'
       - name: Install Julia dependencies
         shell: julia --project=monorepo {0}
         run: |
           using Pkg;
           pkg"dev ./NDTensors . ./ITensorVisualizationBase ./ITensorUnicodePlots"
-        if: steps.check.outputs.triggered == 'true'
       - name: Run the tests
-        run: >
+        run: |
           julia --project=monorepo --depwarn=yes -e 'using Pkg; Pkg.test("ITensorUnicodePlots")'
-        if: steps.check.outputs.triggered == 'true'
+      - name: Set latest commit status as ${{ job.status }}
+        uses: myrotvorets/set-commit-status-action@master
+        if: always()
+        with:
+          sha: ${{ steps.comment-branch.outputs.head_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+      - name: Add comment to PR
+        uses: actions/github-script@v6
+        if: always()
+        with:
+          script: |
+            const name = '${{ github.workflow   }}';
+            const url = '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}';
+            const success = '${{ job.status }}' === 'success';
+            const body = `${name}: ${success ? 'succeeded ✅' : 'failed ❌'}\n${url}`;
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: body
+            })
diff --git a/.github/workflows/comment_trigger_test_itensorvisualization.yml b/.github/workflows/comment_trigger_test_itensorvisualization.yml
