A happy little GitHub Action that checks your README.md and other markdown for broken links. Uses linkinator under the hood.

With no arguments, this will scan your README.md in the root of the GitHub repository:

on:
  push:
    branches:
      - main
  pull_request:
name: ci
jobs:
  linkinator:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: JustinBeckwith/linkinator-action@v1

Or you can pass many of the same parameters linkinator provides!

on:
  push:
    branches:
      - main
  pull_request:
name: ci
jobs:
  linkinator:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: JustinBeckwith/linkinator-action@v1
        with:
          paths: test/fixtures/test.md
          concurrency: 1
          markdown: true
          linksToSkip: "http://fake.local, http://fake.local/fake"

• paths - Paths to scan for 404s. Defaults to *.md.
• concurrency - The number of connections to make simultaneously. Defaults to 100.
• recurse - Recursively follow links on the same root domain. Defaults to false.
• linksToSkip - List of urls in regexy form to not include in the check.
• timeout - Request timeout in ms. Defaults to 0 (no timeout).
• markdown - Automatically parse and scan markdown if scanning from a location on disk. Defaults to true.
• serverRoot - When scanning a locally directory, customize the location on disk where the server is started. Defaults to the root of your GitHub repository.

• results - An object with the results of the run.

MIT