Refactor main pipeline

Author: AFulgens

.github/workflows/main.yml

@@ -1,51 +1,106 @@
-name: Testing pipeline
+name: Typecheck & run tests
 
 on:
   push:
     branches:
     - 'main'
     - 'feature/*'
     - 'bugfix/*'
+  issue_comment:
+    types: [created]
 
 jobs:
-  sanity-run:
+  get-main-ref:
     runs-on: ubuntu-latest
-    name: Run tests on lowest supported Python version on Ubuntu as a sanity-check before doing anything else
+    name: Get ref to check out (based on branch or PR)
+    permissions:
+      statuses: write
+    steps:
+    - name: Get PR's branch name
+      id: from-pr
+      if: ${{ contains(github.event.comment.html_url, '/pull/') }}
+      run: |
+        PR=$(curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" ${{ github.event.issue.pull_request.url }})
+        echo "branch=$(echo $PR | jq -r '.head.ref')" >> "$GITHUB_OUTPUT"
+        echo "sha=$(echo $PR | jq -r '.head.sha')" >> "$GITHUB_OUTPUT"
+        echo "onPR=true" >> "$GITHUB_OUTPUT"
+    - name: Bind check in PR
+      id: bind-pr
+      if: ${{ steps.from-pr.outputs.onPR }}
+      uses: myrotvorets/[email protected]
+      with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          sha: ${{ steps.from-pr.outputs.sha }}
+          status: pending
+          context: Run based on PR comment
+    - name: Get current branch name
+      id: from-branch
+      if: ${{ !contains(github.event.comment.html_url, '/pull/') }}
+      run: |
+        echo "branch=${{ github.head_ref || github.ref_name }}" >> "$GITHUB_OUTPUT"
+        echo "sha=..." >> "$GITHUB_OUTPUT"
+        echo "onPR=false" >> "$GITHUB_OUTPUT"
+    outputs:
+      branch: ${{ steps.from-pr.outputs.branch || steps.from-branch.outputs.branch }}
+      sha: ${{ steps.from-pr.outputs.sha || steps.from-branch.outputs.sha }}
+      onPR: ${{ steps.from-pr.outputs.onPR || steps.from-branch.outputs.onPR }}
+
+  coverage:
+    runs-on: ubuntu-latest
+    name: Run tests on lowest supported Python version on Ubuntu
+    needs: [get-main-ref]
     steps:
     - name: Checkout current branch
       uses: actions/checkout@v4
       with:
-        ref: ${{ github.ref_name }}
+        ref: ${{ needs.get-main-ref.outputs.branch }}
     - uses: actions/setup-python@v5
       with:
         python-version: '3.9'
     - run: python -m pip install --upgrade setuptools virtualenv
     - run: pip install -r requirements-dev.txt
     - run: pytest --cov=hooks --cov-fail-under=100
 
-  main:
+  type-check:
+    if: ${{ !needs.get-main-ref.outputs.onPR || (contains(github.event.comment.body, '/type-check') || contains(github.event.comment.body, '/all-tests')) }}
     runs-on: ubuntu-latest
-    name: Run all tests, run static type analysis, coverage, and mutation tests
-    needs: sanity-run
+    name: Type checking
+    needs: [get-main-ref]
     steps:
     - name: Checkout current branch
       uses: actions/checkout@v4
       with:
-        ref: ${{ github.ref_name }}
+        ref: ${{ needs.get-main-ref.outputs.branch }}
     - uses: actions/setup-python@v5
       with:
-        python-version: '3.12'
+        python-version: '3.9'
     - run: python -m pip install --upgrade setuptools virtualenv
     - run: pip install -r requirements-dev.txt
     - run: mypy hooks
-    - run: pytest --cov=hooks --cov-fail-under=100
+
+  mutate:
+    if: ${{ !needs.get-main-ref.outputs.onPR || (contains(github.event.comment.body, '/mutate') || contains(github.event.comment.body, '/all-tests')) }}
+    runs-on: ubuntu-latest
+    name: Mutation tests
+    needs: [get-main-ref, coverage]
+    steps:
+    - name: Checkout current branch
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ needs.get-main-ref.outputs.branch }}
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - run: python -m pip install --upgrade setuptools virtualenv
+    - run: pip install -r requirements-dev.txt
+    - run: pytest --cov=hooks
     - run: mutmut run --paths-to-mutate "./hooks/" --use-coverage --no-progress
 
   combos:
-    if: github.ref == 'refs/heads/main'
+    if: ${{ !needs.get-main-ref.outputs.onPR || (contains(github.event.comment.body, '/combos') || contains(github.event.comment.body, '/all-tests')) }}
     runs-on: ${{ matrix.os }}
-    name: ${{ matrix.os }} / ${{ matrix.env }}
-    needs: main
+    name: Tests on ${{ matrix.os }} with Python ${{ matrix.env }}
+    needs: [get-main-ref, coverage]
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
@@ -61,10 +116,27 @@ jobs:
     - name: Checkout current branch
       uses: actions/checkout@v4
       with:
-        ref: ${{ github.ref_name }}
+        ref: ${{ needs.get-main-ref.outputs.branch }}
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.env }}
     - run: python -m pip install --upgrade setuptools virtualenv
     - run: pip install -r requirements-dev.txt
     - run: pytest
+
+  update-pr:
+    if: ${{ needs.get-main-ref.outputs.onPR }}
+    runs-on: ubuntu-latest
+    name: Report back in PR when triggered by comment
+    permissions:
+      statuses: write
+    needs: [get-main-ref, type-check, mutate, combos]
+    steps:
+      - name: Set final commit status
+        uses: myrotvorets/[email protected]
+        if: always()
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          sha: ${{ needs.get-main-ref.outputs.sha }}
+          status: ${{ job.status }}
+          context: Run based on PR comment