Skip to content

chore(deps): bump the npm_and_yarn group across 3 directories with 4 … #187

chore(deps): bump the npm_and_yarn group across 3 directories with 4 …

chore(deps): bump the npm_and_yarn group across 3 directories with 4 … #187

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [main]
paths:
- 'docs/**'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions: {}
concurrency:
group: pages
cancel-in-progress: false
jobs:
zizmor:
name: Workflow Security
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
persist-credentials: false
- uses: zizmorcore/zizmor-action@135698455da5c3b3e55f73f4419e481ab68cdd95 # v0.4.1
with:
advanced-security: false
online-audits: false
deploy:
needs: zizmor
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
persist-credentials: false
- uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2
with:
shared-key: docs-validation-v1
cache-all-crates: true
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
with:
node-version: "22"
cache: npm
cache-dependency-path: docs/package-lock.json
- name: Install docs validation tools
run: |
cargo install mdbook-lint --version 0.14.3 --locked
cargo install lychee --version 0.24.2 --locked
- name: Install documentation dependencies
working-directory: docs
run: npm ci
- name: Lint documentation markdown
working-directory: docs
run: mdbook-lint lint --enable MD001,MD003,MD009,MD010,MD011,MD014 src
- name: Build documentation
working-directory: docs
run: npm run build
- name: Check generated documentation links
working-directory: docs
run: lychee --offline --root-dir "$PWD/dist" --no-progress dist
- name: Add CNAME for custom domain
run: echo "docs.moltis.org" > docs/dist/CNAME
- name: Deploy to gh-pages branch
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/dist
cname: docs.moltis.org