https://github.com/paramt/url-checker

A GitHub action to test for broken links
https://github.com/paramt/url-checker

actions link-checker python url-checker

Last synced: 18 days ago
JSON representation

A GitHub action to test for broken links

• Host: GitHub
• URL: https://github.com/paramt/url-checker
• Owner: paramt
• Created: 2019-09-29T21:06:13.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T18:05:42.000Z (about 1 year ago)
• Last Synced: 2024-09-19T14:35:05.689Z (3 months ago)
• Topics: actions, link-checker, python, url-checker
• Language: Python
• Homepage: https://github.com/marketplace/actions/url-checker
• Size: 118 KB
• Stars: 30
• Watchers: 2
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - paramt/url-checker - A GitHub action to test for broken links (Python)

README

        
# URL Checker

A GitHub action to test for broken links on markdown files

### Sample Workflow

```yml

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](https://i.imgur.com/35zldHS.png)](https://github.com/paramt/url-checker/commit/093ef6cb5f7e9eff8300887f07eb0c3a55f4aa82/checks)