https://github.com/leandrols/linksnitch

A Github Action that verify if your README.md has broken links
https://github.com/leandrols/linksnitch

broken-link-finder github-actions golang

Last synced: 11 months ago
JSON representation

A Github Action that verify if your README.md has broken links

• Host: GitHub
• URL: https://github.com/leandrols/linksnitch
• Owner: LeandroLS
• License: mit
• Created: 2021-11-10T23:02:49.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-07-07T22:54:58.000Z (almost 4 years ago)
• Last Synced: 2025-07-08T11:16:50.833Z (12 months ago)
• Topics: broken-link-finder, github-actions, golang
• Language: Go
• Homepage:
• Size: 25.4 KB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# linksnitch 🔗

A GitHub Action that automatically check the status codes response of links in README.md. Useful for checking broken links.

## How to use

In your `.yml` workflow file:

```yml

name: A workflow that check if links in README.md is working

on: push

jobs:

  build:

    name: Check if README.md links work

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - uses: LeandroLS/linksnitch@main

        with:

          allowedStatusCodes: '[200, 201]'

```

In `allowdStatusCodes` you can set all the status codes that your links can return. If your README.md has some link that don't return one of the status codes set in `allowedStatusCodes` the workflow will fail and will show to you what links is broken.

#### Badges

[![test](https://github.com/LeandroLS/linksnitch/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/LeandroLS/linksnitch/actions/workflows/test.yml)