workflow-validate-repo-markdown.yml

name: Validate Repo Markdown
on:
  workflow_call:
    inputs:
      ignorePattern:
        description: 'a pattern provided to grep for files/directories to ignore'
        required: false
        default: '^website/'
        type: string
      markdownLinkCheckConfig:
        description: 'the path to the markdown link check config file'
        required: false
        default: '.github/workflows/config/.markdown-link-check/config.json'
        type: string
      linkcheck_create_issue:
        description: 'create new GitHub issue if broken links found'
        required: false
        default: false
        type: boolean
jobs:
  validate-repo-markdown:
    name: Validate Repo Markdown
    runs-on: ubuntu-20.04
    permissions:
      contents: read
      issues: write
    steps:
    # use this for pulls where checkout is anonymous
    - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633
      with:
        submodules: recursive
    # Setup runtime environment
    # -------------------------
    - name: Set up NodeJS
      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8
      with:
        node-version-file: '.github/workflows/config/.nvmrc'
        cache: 'npm'
        cache-dependency-path: 'package-lock.json'
    - name: Setup Dependencies
      run: |
        # NodeJS
        # If you are a developer and need to modify the workflow, be sure to review
        # the package.json and package-lock.json to ensure the following deps are
        # at least installed (they will be updated by dependabot):
        # - ajv-cli
        # - ajv-formats
        # - markdown-link-check
        # - yaml-convert
        npm install --loglevel verbose
        echo "$PWD/node_modules/.bin/" >> $GITHUB_PATH
    # Build Artifacts
    # ---------------
    - name: Validate repo Markdown content instances
      run: |
        # this command will filter out any docs Markdown files, which are checked in a different job
        git ls-files "*.md" -z | \
        grep --null-data -v "${{ inputs.ignorePattern }}" | \
        xargs -0 markdown-link-check -c "${{ inputs.markdownLinkCheckConfig }}" | \
        tee mlc_report.log
        # Exit code of xargs and markdown-link-check, not git or grep or tee pipe elements
        exit ${PIPESTATUS[2]}
      id: linkchecker
    - name: Create issue if bad links detected in repo
      if: failure() && inputs.linkcheck_create_issue == true
      uses: peter-evans/create-issue-from-file@24452a72d85239eacf1468b0f1982a9f3fec4c94 # v3.0.0
      with:
        title: Scheduled Check of Markdown Documents Found Bad Hyperlinks
        content-filepath: mlc_report.log
        labels: |
          bug
          documentation