#/
# @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: markdown_links

# Workflow triggers:
on:
  schedule:
    # Run the workflow once a month on the 1st day of every month:
    - cron: '0 0 1 * *'

  # 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 detecting broken links in Markdown files...
  markdown_links:

    # Define a display name:
    name: 'Check links'

    # 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 environment variables:
    env:
      LOG_DIR: "${{ github.workspace }}/tmp/var/log"
      LOG_FILE_FAILURES: "${{ github.workspace }}/tmp/var/log/failures.json"
      LOG_FILE_WARNINGS: "${{ github.workspace }}/tmp/var/log/warnings.json"

    # Set defaults:
    defaults:
      run:
        # Set the default shell to `bash`:
        shell: bash --noprofile --norc -eo pipefail {0}

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

      # Checkout the repository:
      - name: 'Checkout repository'
        # Pin action to full length commit SHA
        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
        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

      # Initialize log files:
      - name: 'Initialize log files'
        run: |
          mkdir -p "${{ env.LOG_DIR }}"
          touch "${{ env.LOG_FILE_FAILURES }}"
          touch "${{ env.LOG_FILE_WARNINGS }}"
        timeout-minutes: 2

      # Check for broken links:
      - name: 'Check links'
        uses: stdlib-js/check-markdown-link-definitions-action@main
        id: results
        with:
          exclude: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules
        timeout-minutes: 240

      # Install Node.js:
      - name: 'Install Node.js'
        # Pin action to full length commit SHA
        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.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

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

      # Check whether links are included in `docs/links/database.json` and use the correct identifier:
      - name: 'Check links against database'
        run: |
          # Determine root directory:
          root=$(git rev-parse --show-toplevel)

          # Define the path to a utility for validating links:
          validate="${root}/lib/node_modules/@stdlib/_tools/links/validate/bin/cli"

          echo "## Link Validation" >> $GITHUB_STEP_SUMMARY

          output=$(echo '${{ steps.results.outputs.all_links }}' | ${validate})
          if [[ "${output}" != "All links are valid." ]]; then
            echo "| URL | ID | Error |" >> $GITHUB_STEP_SUMMARY
            echo "| --- | -- | ----- |" >> $GITHUB_STEP_SUMMARY

            echo "$output" | jq -r '.[] | [.error, .id, .url] | @tsv' | while IFS=$'\t' read -r error id url; do
              echo "| $url | \`$id\` | $error |" >> $GITHUB_STEP_SUMMARY
            done
          else
            echo "$output"
          fi

      # Log the results:
      - name: 'Log results'
        run: |
          echo ${{ steps.results.outputs.failures }} >> "${{ env.LOG_FILE_FAILURES }}"
          echo ${{ steps.results.outputs.warnings }} >> "${{ env.LOG_FILE_WARNINGS }}"
        timeout-minutes: 2

      # Fail the workflow if the status is not "success":
      - name: 'Check status'
        if: ${{ steps.results.outputs.status }} != 'success'
        run: |
          exit 1

      # View the log file if the previous step fails:
      - name: 'View log file'
        if: failure()
        run: |
          echo "Printing the list of failures..."
          cat "${{ env.LOG_FILE_FAILURES }}"
        timeout-minutes: 5

      # Upload the log files:
      - name: 'Upload log files'
        # Pin action to full length commit SHA
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        if: always()
        with:
          # Define a name for the uploaded artifact:
          name: results

          # Specify the paths to upload:
          path: |
            ${{ env.LOG_FILE_FAILURES }}
            ${{ env.LOG_FILE_WARNINGS }}

          # Specify the number of days to retain the artifact (default is 90 days):
          retention-days: 10
        timeout-minutes: 10

  # Define a job for sending notifications to Slack...
  slack:

    # Define a display name:
    name: 'Slack notification'

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

    # Indicate that this job depends on the prior job finishing:
    needs: markdown_links

    # Run this job regardless of the outcome of the prior job:
    if: always()

    # Set defaults:
    defaults:
      run:
        # Set the default shell to `bash`:
        shell: bash --noprofile --norc -eo pipefail {0}

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

      # Resolve notification data:
      - name: 'Resolve notification data'
        run: |
          echo 'NOTIFICATION_STATUS=${{ needs.markdown_links.result}}' >> $GITHUB_ENV
          if [[ "${{ needs.markdown_links.result }}" = "success" ]]; then
            echo 'NOTIFICATION_TEXT=**markdown_links** workflow succeeded' >> $GITHUB_ENV
            echo 'NOTIFICATION_AUTHOR_NAME=Success' >> $GITHUB_ENV
          elif [[ "${{ needs.markdown_links.result }}" = "failure" ]]; then
            echo 'NOTIFICATION_TEXT=**markdown_links** workflow failed' >> $GITHUB_ENV
            echo 'NOTIFICATION_AUTHOR_NAME=Failure' >> $GITHUB_ENV
          elif [[ "${{ needs.markdown_links.result }}" = "cancelled" ]]; then
            echo 'NOTIFICATION_TEXT=**markdown_links** workflow was canceled' >> $GITHUB_ENV
            echo 'NOTIFICATION_AUTHOR_NAME=Canceled' >> $GITHUB_ENV
          else
            exit 1
          fi
        timeout-minutes: 5

      # Send notification to Slack:
      - name: 'Send notification'
        # Pin action to full length commit SHA
        uses: 8398a7/action-slack@77eaa4f1c608a7d68b38af4e3f739dcd8cba273e # v3.19.0
        if: success()
        with:
          status: "${{ env.NOTIFICATION_STATUS }}"
          fields: repo,commit,message
          text: "${{ env.NOTIFICATION_TEXT }}"
          author_name: "${{ env.NOTIFICATION_AUTHOR_NAME }}"
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.REPO_SLACK_WEBHOOK_URL }}
        timeout-minutes: 5