link-check.yaml

#
# MIT License
#
# (C) Copyright 2022-2023 Hewlett Packard Enterprise Development LP
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.

name: Markdown linkcheck

on:
  pull_request:
  workflow_dispatch:
    inputs:
      force_full_scan:
        description: 'Enforce link checking on all files'
        required: false
        type: boolean

jobs:
  markdown-link-check:
    runs-on: [ self-hosted ]
    container:
      image: arti.hpc.amslabs.hpecorp.net/third-party-docker-stable-local/ghcr.io/tcort/markdown-link-check:3.9.3
      options: --entrypoint ""
    steps:
    - uses: actions/checkout@v3

    - name: Get changed Markdown files
      id: get-changed-files
      uses: actions/github-script@v6
      with:
        script: |
          // Get the pull request number from the context
          const pull_number = context.payload.pull_request.number;

          // Fetch the list of changed files in the pull request
          const response = await github.rest.pulls.listFiles({
            owner: context.repo.owner,
            repo: context.repo.repo,
            pull_number: pull_number,
          });

          // Filter for markdown files and join them into a space-separated string
          const changedFiles = response.data
            .filter(file => file.filename.endsWith('.md'))
            .map(file => file.filename)
            .join(' ');

          // Log the changed files for debugging
          console.log('Changed Markdown files:', changedFiles);

          // Set the output for the changed files
          core.setOutput('changed_files', changedFiles);

    - name: Check links in changed files
      if: steps.get-changed-files.outputs.changed_files != ''
      run: |
        for file in ${{ steps.get-changed-files.outputs.changed_files }}; do
          markdown-link-check --config .github/config/markdown_link.json "$file"
        done

    - name: Full scan
      if: steps.get-changed-files.outputs.changed_files == '' || inputs.force_full_scan
      run: |
        find . -name "*.md" -not -path "./.github/*" -exec sh -c "set -o pipefail; markdown-link-check --config .github/config/markdown_link.json {} 2>&1 | tee output.txt || cat output.txt >> error.txt" ";"

    - name: Report errors
      if: always()
      run: |
        if [ -f error.txt ]; then
          cat error.txt
          exit 1
        fi