You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 18, 2022. It is now read-only.
If Link Checker finds connectivity problems with links the action will output a markdown file containing the error report.
The default path is link-checker/out.md. The path and filename may be overridden with the following variables.
LINKCHECKER_OUTPUT_DIR - The output directory the markdown error report
LINKCHECKER_OUTPUT_FILENAME - The error report filename
Receiving issues containing the error report
Below is an example of using this action in conjunction with Create Issue From File. The workflow executes on a schedule every month. Issues will be created when Link Checker finds connectivity problems with links.
on:
schedule:
- cron: '0 0 1 * *'name: Check markdown linksjobs:
linkChecker:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v2
- name: Link Checkeruses: peter-evans/link-checker@v1
- name: Create Issue From Fileuses: peter-evans/create-issue-from-file@v2with:
title: Link Checker Reportcontent-filepath: ./link-checker/out.mdlabels: report, automated issue
To create a failing check when there are link errors you can use the exit_code output from the action as follows.
on: pushjobs:
linkChecker:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v2
- name: Link Checkerid: lcuses: peter-evans/link-checker@v1
- name: Fail if there were link errorsrun: exit ${{ steps.lc.outputs.exit_code }}