URLs-checker

A GitHub action to collect and check URLs in a project (code and documentation). The action aims at detecting and reporting broken links.

How to use?

Example

name: Check URLs

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: URLs-checker
      uses: SuperKogito/URLs-checker@0.1.2
      with:
        # The project base path.
        git_path: https://github.com/SuperKogito/SuperKogito.github.io

        # A comma-separated list of file types to cover in the URL checks
        file_types: .md,.py,.rst

        # Choose whether to include file with no URLs in the prints.
        print_all: False

        # A comma separated links to exclude during URL checks
        white_listed_urls: https://superkogito.github.io/figures/fig2.html, https://superkogito.github.io/figures/fig4.html

        # A comma separated patterns to exclude during URL checks
        white_listed_patterns: https://superkogito.github.io/tables

Inputs

variable name	variable type	variable description
git_path	required	The path to the start directory of the project.
file_types	optional	A comma-separated list of file types to cover in the URLs checks.
print_all	optional	Choose whether to include file with no URLs in the prints.
white_listed_urls	optional	A comma separated links to exclude during URL checks.
white_listed_patterns	optional	A comma separated patterns to exclude during URL checks.

Demo