test.yml

#/
# @license Apache-2.0
#
# Copyright (c) 2021 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: test

# Workflow triggers:
on:
  # Run workflow on a weekly schedule:
  schedule:
    # * is a special character in YAML so you have to quote this string
    - cron:  '9 21 * * 1'

  # Allow the workflow to be manually run:
  workflow_dispatch:

  # Run workflow on each push to the main branch:
  push:

  # Run workflow upon completion of `publish` workflow run:
  workflow_run:
    workflows: ["publish"]
    types: [completed]

# Workflow jobs:
jobs:

  # Define job to run tests...
  test:

    # Define display name:
    name: 'Run tests'

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

    # Define environment variables:
    env:
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

    # Define the sequence of job steps...
    steps:

      # Checkout the repository:
      - name: 'Checkout repository'
        # Pin action to full length commit SHA
        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0

      # Install Node.js:
      - name: 'Install Node.js'
        # Pin action to full length commit SHA
        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
        with:
          node-version: 20
        timeout-minutes: 5

      # Install dependencies:
      - name: 'Install production and development dependencies'
        id: install
        run: |
          npm install || npm install || npm install
        timeout-minutes: 15

      # Build native add-on if present:
      - name: 'Build native add-on (if present)'
        run: |
          if [ -f "binding.gyp" ]; then
            npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild
          fi

      # Run tests:
      - name: 'Run tests'
        id: tests
        run: |
          npm test || npm test || npm test

      # Send status to Slack channel if job fails:
      - name: 'Send status to Slack channel in case of failure'
        # Pin action to full length commit SHA corresponding to v2.0.0
        uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f
        with:
          status: ${{ job.status }}
          steps: ${{ toJson(steps) }}
          channel: '#npm-ci'
        if: failure()