Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Nov 30, 2022. It is now read-only.

technote-space/broken-link-checker-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

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

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

About

GitHub Actions to check broken links and create issues.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 2

AltStyle によって変換されたページ (->オリジナル) /