Skip to content

Check for Broken Links and Publish Wiki #23

Check for Broken Links and Publish Wiki

Check for Broken Links and Publish Wiki #23

name: Check for Broken Links and Publish Wiki
'on':
push:
paths:
- '**/*.md'
- 'wiki/**'
pull_request:
types: [ opened ]
branches: [ main ]
workflow_dispatch:
schedule:
# every monday at night
- cron: '0 1 * * 1'
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: "Setup the Environment"
uses: Code-Inspect/flowr/.github/actions/setup@main
- name: "Checkout Repository"
uses: actions/checkout@v4
with:
lfs: true
submodules: true
- name: "Checkout LFS"
run: git lfs checkout
- name: Update the Capabilities Wiki Page
run: |
npm ci
npm run capabilities-markdown --silent > wiki/Capabilities-New.md
- name: Check the README for broken links
uses: becheran/[email protected]
with:
args: README.md
- name: Publish the Wiki
uses: Andrew-Chen-Wang/github-wiki-action@v4
# we do not need to republish if nothing changes furthermore, do not publish on PR as this should be done by the push on main!
if: ${{ (github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main')) && !failure() }}
with:
path: "wiki/"
token: ${{ secrets.GH_DEPLOY_WIKI }}
- name: Check the Wiki pages for broken links
uses: becheran/[email protected]
if: ${{ always() && !failure() }}
with:
args: wiki/