Skip to content

Validate docs

Validate docs #17

name: Validate docs
on:
workflow_dispatch:
jobs:
lint-readme-examples:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
sparse-checkout: |
README.md
.github/settings/docs-lint-and-validate/
# sparse-checkout-cone-mode: false
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '16'
cache: 'npm'
cache-dependency-path: './package-lock.json'
- name: Install dependencies
run: npm ci
- name: Create temp directory
run: mkdir -p temp
- name: Move eslint settings files to temp directory
run: mv .github/settings/docs-lint-and-validate/* temp/
- name: Extract TypeScript examples from README
uses: firebolt-db/action-extract-doc-code@demo
with:
input_file: README.md
language: typescript
output_file: temp/extracted-code.ts
block_number: 2 # Quickstart
# - name: Check TypeScript compilation
# run: cd temp && npx tsc --noEmit --project tsconfig.json
- name: Lint extracted examples
run: cd temp && npx eslint *.ts --config ../.eslintrc
- name: Clean up
if: always()
run: rm -rf temp