Skip to content

Check for broken links in docs #593

Check for broken links in docs

Check for broken links in docs #593

# Perform link check on all markdown files
# https://github.com/gaurav-nelson/github-action-markdown-link-check
name: Check for broken links in docs
on:
workflow_dispatch:
schedule:
- cron: '0 18 * * *'
jobs:
markdown-link-check:
timeout-minutes: 50
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
# check all files on master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
check-modified-files-only: 'no'
config-file: .github/workflows/doc-link-check.json
# posts to #_doc_link_checker
- name: Publish Success to Slack
if: success()
uses: abinoda/slack-action@master
env:
SLACK_BOT_TOKEN: ${{ secrets.DOC_LINK_CHECKER_BOT_TOKEN }}
with:
args: >-
{\"channel\": \"C02MG7B7MT6\", \"blocks\":[
{\"type\":\"section\",\"text\":{\"type\":\"mrkdwn\",\"text\":\"Succeeded! :white_check_mark:\n\"}},
{\"type\":\"section\",\"text\":{\"type\":\"mrkdwn\",\"text\":\":octavia-rocket: <https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}|View Action Run> :octavia-rocket:\"}},
{\"type\":\"divider\"}]}
# posts to #_doc_link_checker
- name: Publish Failure to Slack
if: failure()
uses: abinoda/slack-action@master
env:
SLACK_BOT_TOKEN: ${{ secrets.DOC_LINK_CHECKER_BOT_TOKEN }}
with:
args: >-
{\"channel\": \"C02MG7B7MT6\", \"blocks\":[
{\"type\":\"divider\"},
{\"type\":\"section\",\"text\":{\"type\":\"mrkdwn\",\"text\":\"Failed! :bangbang:\n\"}},
{\"type\":\"section\",\"text\":{\"type\":\"mrkdwn\",\"text\":\":octavia-rocket: <https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}|View Action Run> :octavia-rocket:\"}},
{\"type\":\"divider\"}]}