broken-link-checker-action icon indicating copy to clipboard operation
broken-link-checker-action copied to clipboard

Published 20 hours ago • verified publisher icon technote-space
→

Metadata

GitHub Actions to check broken links and create issues.

Broken Link Checker Action

CI Status codecov CodeFactor License: MIT

Read this in other languages: English, 日本語.

GitHub Actions that detects broken links in a page with a specified URL and creates issues.

Table of Contents

Details
  • Usage
  • Screenshot
  • Options
  • Author

Usage

e.g. .github/workflows/broken-link-check.yml

on:
  schedule:
    - cron: 0 0 1 * * # run monthly
  repository_dispatch: # run manually
    types: [check-link]
  # push:
  # ...

name: Broken Link Check
jobs:
  check:
    name: Broken Link Check
    runs-on: ubuntu-latest
    steps:
      - name: Broken Link Check
        uses: technote-space/broken-link-checker-action@v2

Screenshot

issue

Options

name description default required e.g.
TARGET Target link https://github.com/${{ github.repository }} true https://example.com
RECURSIVE Recursive? true
TITLE Issue title Broken link found (${URL}) true ${URL} is broken
BODY Issue body see action.yml true
LABELS Labels
ASSIGNEES Assignees
GITHUB_TOKEN Access token ${{github.token}} true ${{secrets.ACCESS_TOKEN}}

Author

GitHub (Technote)
Blog

← Metadata

24
Stars
6
Forks
Watchers

Owner

verified publisher icon technote-space

Metadata

GitHub Actions to check broken links and create issues.

Back