url-checker icon indicating copy to clipboard operation
url-checker copied to clipboard

A GitHub action to test for broken links

URL Checker

A GitHub action to test for broken links on markdown files

Sample Workflow

name: Sample Workflow

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Check URLs
        uses: paramt/url-checker@master
        with:
          files: "README.md,SUPPORT.md"

Arguments

  • files: A comma-separated list of files to check. Defaults to README.md
  • blacklist: A comma-separated list of URLs to ignore

Sample Output

Example