Skip to content

Validate docs

Validate docs #5

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
package.json
package-lock.json
.eslintrc
sparse-checkout-cone-mode: false
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '16'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Create temp directory
run: mkdir -p temp
- name: Extract JavaScript 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: Upload extracted code as artifact
uses: actions/upload-artifact@v4
with:
name: extracted-code.ts
path: temp/extracted-code.ts
retention-days: 2
- name: Lint extracted examples
run: npx eslint temp/extracted-code.ts
- name: Clean up
if: always()
run: rm -rf temp