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

GitHub Action

Broken Link Checker Action

v1.1.0

Broken Link Checker Action

link

Broken Link Checker Action

GitHub Actions to check broken links and create issues

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Broken Link Checker Action

uses: technote-space/[email protected]

Learn more about this action in technote-space/broken-link-checker-action

Choose a version

Broken Link Checker Action

CI Status codecov CodeFactor License: MIT

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

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

Screenshot

issue

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