docs: routine lint for markdown code run #1220
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | |
| test-documentation: | |
| runs-on: ubuntu-20.04 | |
| name: Test Generating Docs | |
| steps: | |
| - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 | |
| - run: git fetch --depth=1 --tags # download all tags for documentation | |
| - name: Setup node | |
| uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 | |
| with: | |
| node-version: 16 | |
| - run: npm install | |
| - run: npm run docs:clean | |
| - run: npm run docs:generate |