update_math_scaffold_databases.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: update_math_scaffold_databases

# Workflow triggers:
on:
  push:
    paths:
      # List paths for which changes should trigger this workflow:
      - 'lib/node_modules/@stdlib/math/special/data/unary_function_database.json'
      - 'lib/node_modules/@stdlib/math/base/special/*/package.json'
      - 'lib/node_modules/@stdlib/number/float64/base/*/package.json'
      - 'lib/node_modules/@stdlib/number/float32/base/*/package.json'
      - 'lib/node_modules/@stdlib/number/float16/base/*/package.json'
      - 'lib/node_modules/@stdlib/complex/float64/base/*/package.json'
      - 'lib/node_modules/@stdlib/complex/float32/base/*/package.json'
      - 'lib/node_modules/@stdlib/complex/float16/base/*/package.json'

  # Allow the workflow to be manually run:
  workflow_dispatch:

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

# Workflow jobs:
jobs:

  # Define a job for updating databases which are used for scaffolding mathematical packages...
  update:

    # Define a display name:
    name: 'Update Scaffold Databases'

    # Ensure the job does not run on forks:
    if: github.repository == 'stdlib-js/stdlib'

    # 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@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
        with:
          # Specify whether to remove untracked files before checking out the repository:
          clean: true

          # Limit clone depth to the most recent commit:
          fetch-depth: 1

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

          # Avoid storing GitHub token in local Git configuration:
          persist-credentials: false
        timeout-minutes: 10

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

      # Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
      - name: 'Install dependencies'
        run: |
          make install-node-modules || make install-node-modules || make install-node-modules
        timeout-minutes: 15

      # Update the unary database:
      - name: 'Update unary database'
        run: |
          node lib/node_modules/@stdlib/math/special/scripts/generate_unary_database.js

      # Check if there are any changes to the unary database:
      - name: 'Check for changes'
        id: check_changes
        run: |
          if [ -z "$(git diff lib/node_modules/@stdlib/math/special/data/unary.json)" ]; then
            echo "No changes detected in unary database. Skipping PR creation."
            echo "has_changes=false" >> $GITHUB_OUTPUT
          else
            echo "Changes detected in unary database."
            echo "has_changes=true" >> $GITHUB_OUTPUT
          fi

      # Import GPG key to sign commits:
      - name: 'Import GPG key to sign commits'
        if: steps.check_changes.outputs.has_changes == 'true'
        # Pin action to full length commit SHA
        uses: crazy-max/ghaction-import-gpg@e89d40939c28e39f97cf32126055eeae86ba74ec # v6.3.0
        with:
          gpg_private_key: ${{ secrets.STDLIB_BOT_GPG_PRIVATE_KEY }}
          passphrase: ${{ secrets.STDLIB_BOT_GPG_PASSPHRASE }}
          git_user_signingkey: true
          git_commit_gpgsign: true

      # Create a pull request with the updated databases:
      - name: 'Create pull request'
        if: steps.check_changes.outputs.has_changes == 'true'
        id: cpr
        # Pin action to full length commit SHA
        uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
        with:
          title: 'feat: update math scaffold databases'
          body: |
            This PR

            -   updates the databases for scaffolding mathematical databases

          commit-message: 'feat: update math scaffold databases'
          committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
          signoff: true
          token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
          labels: |
            automated-pr
          team-reviewers: |
            reviewers
          branch: update-math-scaffold-databases
          delete-branch: true

      # Create a pull request summary:
      - name: 'Create summary'
        if: steps.check_changes.outputs.has_changes == 'true'
        run: |
          echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "Pull request ${{ steps.cpr.outputs.pull-request-number }} was successfully ${{ steps.cpr.outputs.pull-request-operation }}."
          echo ":link: [${{ steps.cpr.outputs.pull-request-url }}](${{ steps.cpr.outputs.pull-request-url }})." >> $GITHUB_STEP_SUMMARY
          echo "Head SHA: [${{ steps.cpr.outputs.pull-request-head-sha }}](${{ steps.cpr.outputs.pull-request-url }}/commits/${{ steps.cpr.outputs.pull-request-head-sha }})." >> $GITHUB_STEP_SUMMARY