Skip to content

Merge pull request #14255 from monkbroc/patch-2 #1582

Merge pull request #14255 from monkbroc/patch-2

Merge pull request #14255 from monkbroc/patch-2 #1582

Workflow file for this run

name: Documentation
on:
pull_request:
paths:
- '.github/workflows/documentation.yml'
- 'package.json'
- 'docs/**'
- 'lib'
- 'test'
- 'website.js'
- 'CHANGELOG.md'
push:
branches:
- master
paths:
- '.github/workflows/documentation.yml'
- 'package.json'
- 'docs/**'
- 'lib'
- 'test'
- 'website.js'
- 'CHANGELOG.md'
permissions:
contents: read
jobs:
lint-documentation:
runs-on: ubuntu-latest
name: Lint Markdown files
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- name: Setup node
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 16
- run: npm install
- name: Lint MD-Files # run markdownlint
run: npm run lint-md
# enable when "eslint-markdown" can be used without errors
# - name: Lint JS-Files # run eslint to lint the code-blocks themself
# run: npm run lint-js
test-documentation:
runs-on: ubuntu-20.04
name: Test Generating Docs
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- run: git fetch --depth=1 --tags # download all tags for documentation
- name: Setup node
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 16
- run: npm install
- run: npm run docs:clean
- run: npm run docs:generate