run_tests_coverage_pr.yml

#/
# @license Apache-2.0
#
# Copyright (c) 2025 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/

# Workflow name:
name: run_tests_coverage_pr

# Workflow triggers:
on:
  pull_request:
    types:
      - opened
      - synchronize
      - reopened
    paths:
      # List paths for which changes should trigger this workflow:
      - 'lib/**/bin/**'
      - 'lib/**/data/**'
      - 'lib/**/etc/**'
      - 'lib/**/include/**'
      - 'lib/**/lib/**'
      - 'lib/**/src/**'
      - 'lib/**/test/**'

      - 'lib/**/*.gyp'
      - 'lib/**/*.gypi'
      - 'lib/**/manifest.json'

      - 'package.json'

      # List paths for which changes should *not* trigger this workflow:
      - '!lib/**/_tools/**'

# Global permissions:
permissions:
  # Allow read-only access to the repository contents:
  contents: read

# Workflow jobs:
jobs:

  # Define a job for calculating test coverage for changed files...
  coverage:

    # Define a display name:
    name: 'Calculate test coverage for PR packages'

    # Only run this job if the pull request does not have a "ci: Skip" label:
    if: "!contains(github.event.pull_request.labels.*.name, 'ci: Skip')"

    # Define the type of virtual host machine:
    runs-on: ubuntu-latest

    # Define the sequence of job steps...
    steps:
      # Checkout the repository:
      - name: 'Checkout repository'
        # Pin action to full length commit SHA
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          # Specify whether to remove untracked files before checking out the repository:
          clean: true

          # Limit clone depth to the last 1000 commits:
          fetch-depth: 1000

          # Specify whether to download Git-LFS files:
          lfs: false
        timeout-minutes: 10

      # Install Node.js:
      - name: 'Install Node.js'
        # Pin action to full length commit SHA
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: '20' # 'lts/*'
        timeout-minutes: 5

      # Cache dependencies:
      - name: 'Cache dependencies'
        # Pin action to full length commit SHA
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        id: cache
        with:
          path: |
            ${{ github.workspace }}/node_modules
          key: ${{ runner.os }}-node-${{ hashFiles('**/package.json') }}
          restore-keys: |
            ${{ runner.os }}-node-

      # Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
      - name: 'Install dependencies'
        if: steps.cache.outputs.cache-hit != 'true'
        run: |
          make install-node-modules || make install-node-modules || make install-node-modules
        timeout-minutes: 15

      # Initialize development environment:
      - name: 'Initialize development environment'
        run: |
          make init
        timeout-minutes: 5

      # Get list of changed directories:
      - name: 'Get list of changed directories'
        id: changed-directories
        continue-on-error: true
        run: |
          # Get the list of changed files in pull request:
          ancestor_commit=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }})
          files=$(git diff --diff-filter=AM --name-only $ancestor_commit ${{ github.event.pull_request.head.sha }})
          directories=$(for file in $files; do dirname $file; done | sort -u | tr '\n' ' ' | sed 's/ $//')
          echo "directories=${directories}" >> $GITHUB_OUTPUT

      # Exit early if non-package directories are changed:
      - name: 'Exit early if non-package directories are changed'
        id: check-changed
        env:
          DIRECTORIES: ${{ steps.changed-directories.outputs.directories }}
        run: |
          directories="$DIRECTORIES"
          skip="false"
          for directory in $directories; do
            if [[ "$directory" != "lib/node_modules/@stdlib"* ]]; then
              echo "Warning: changed directory '$directory' is not in 'lib/node_modules/@stdlib'. Skipping the rest of the workflow."
              skip="true"
              break
            fi
          done
          echo "skip=${skip}" >> $GITHUB_OUTPUT

      # Run JavaScript tests:
      - name: 'Run JavaScript tests'
        id: extract-coverage
        if: steps.check-changed.outputs.skip == 'false'
        env:
          GITHUB_REPO: ${{ github.repository }}
          GITHUB_REF: ${{ github.ref }}
          COVERAGE_BASE_URL: 'https://coverage.stdlib.io/pr-${{ github.event.pull_request.number }}'
          DIRECTORIES: ${{ steps.changed-directories.outputs.directories }}
        run: |
          directories="$DIRECTORIES"
          . "$GITHUB_WORKSPACE/.github/workflows/scripts/run_tests_coverage/run" "$directories"
        timeout-minutes: 30

      # Create final coverage report:
      - name: 'Create final coverage report'
        id: create-report
        if: steps.check-changed.outputs.skip == 'false'
        env:
          TABLE: ${{ steps.extract-coverage.outputs.table }}
        run: |
          table="$TABLE"
          if [ -z "$table" ]; then
            report="## Coverage Report\n\nNo coverage information available."
          else
            compare_url="https://github.com/stdlib-js/stdlib/compare/${{ github.event.pull_request.base.sha }}...${{ github.event.pull_request.head.sha }}"
            compare_txt="The above coverage report was generated for the [changes in this PR]($compare_url)."
            report="## Coverage Report\n\n${table}\n\n${compare_txt}"
          fi
          echo "report=$report" >> $GITHUB_OUTPUT

      # Save PR metadata for the publish workflow:
      - name: 'Save PR metadata'
        if: steps.check-changed.outputs.skip == 'false'
        env:
          PR_NUMBER: ${{ github.event.pull_request.number }}
          REPORT: ${{ steps.create-report.outputs.report }}
        run: |
          mkdir -p pr-metadata
          printf '%s\n' "$PR_NUMBER" > pr-metadata/pr_number
          printf '%s\n' "$REPORT" > pr-metadata/report

      # Upload PR metadata as artifact:
      - name: 'Upload PR metadata'
        if: steps.check-changed.outputs.skip == 'false'
        # Pin action to full length commit SHA
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: pr-metadata
          path: pr-metadata/
          retention-days: 1

      # Upload coverage artifacts:
      - name: 'Upload coverage artifacts'
        if: steps.check-changed.outputs.skip == 'false'
        # Pin action to full length commit SHA
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: coverage-artifacts
          path: artifacts/
          retention-days: 1