mirror of
https://github.com/Ocelot-Social-Community/Ocelot-Social.git
synced 2025-12-12 23:35:58 +00:00
66 lines
1.9 KiB
YAML
66 lines
1.9 KiB
YAML
name: ocelot.social check documentation
|
|
|
|
on: push
|
|
|
|
jobs:
|
|
files-changed:
|
|
name: Detect File Changes - Markdown files
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
markdown: ${{ steps.changes.outputs.markdown }}
|
|
documentation: ${{ steps.changes.outputs.documentation }}
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@master
|
|
|
|
- name: Check for markdown file changes
|
|
uses: dorny/paths-filter@v2.11.1
|
|
id: changes
|
|
with:
|
|
token: ${{ github.token }}
|
|
filters: .github/file-filters.yml
|
|
list-files: shell
|
|
|
|
check-markdown-links:
|
|
name: Check Markdown links
|
|
needs: files-changed
|
|
runs-on: ubuntu-latest
|
|
if: needs.files-changed.outputs.markdown == 'true'
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@master
|
|
|
|
- name: Remove old documentation files
|
|
run: rm -rf ./deployment/src/old/ ./CHANGELOG.md # workaround until https://github.com/gaurav-nelson/github-action-markdown-link-check/pull/183 has been done
|
|
|
|
- name: Check Markdown Links
|
|
uses: gaurav-nelson/github-action-markdown-link-check@master
|
|
with:
|
|
use-quiet-mode: 'yes'
|
|
use-verbose-mode: 'no'
|
|
# at any .md file change take the chance to check the links in all .md files
|
|
check-modified-files-only: 'no'
|
|
config-file: '.github/workflows/mlc_config.json'
|
|
base-branch: 'master'
|
|
folder-path: '.'
|
|
|
|
test-vuepress-build:
|
|
name: Test Vuepress build
|
|
needs: files-changed
|
|
runs-on: ubuntu-latest
|
|
if: needs.files-changed.outputs.documentation == 'true'
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@master
|
|
|
|
- name: Setup Node 20
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: '20'
|
|
|
|
- name: npm-install
|
|
run: npm install
|
|
|
|
- name: npm-docs:build
|
|
run: npm run docs:build
|