Skip to content
link

GitHub Action

URL Checker

v0.3.1 Latest version

URL Checker

link

URL Checker

Automatically check for broken links in markdown files

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: URL Checker

              
  uses: paramt/url-checker@v0.3.1
Learn more about this action in paramt/url-checker

Choose a version

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