Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Broken Link Checker Action

Actions
GitHub Actions to check broken links and create issues
v1.0.0
Star (25)

Tags

 (1)

Broken Link Checker Action

CI Status codecov CodeFactor License: MIT

GitHub Actions to check broken links and create issues.

Table of Contents

Details

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@v1

Options

name description default required e.g.
TARGET Target link ${{github.event.repository.html_url}} 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

Broken Link Checker Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

GitHub Actions to check broken links and create issues
v1.0.0

Tags

 (1)

Broken Link Checker Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.