Skip to content

Commit cdf5caf

Browse files
committed
test doc validator
1 parent a752daf commit cdf5caf

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Validate docs
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
lint-readme-examples:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout repository
11+
uses: actions/checkout@v4
12+
13+
- name: Setup Node.js
14+
uses: actions/setup-node@v4
15+
with:
16+
node-version: '16'
17+
cache: 'npm'
18+
19+
- name: Install dependencies
20+
run: npm ci
21+
22+
- name: Create temp directory
23+
run: mkdir -p temp
24+
25+
- name: Extract JavaScript examples from README
26+
uses: firebolt-db/action-extract-doc-code@demo
27+
with:
28+
input_file: README.md
29+
language: typescript
30+
output_file: temp/extracted-code.ts
31+
block_number: 2 # Quickstart
32+
33+
- name: Lint extracted examples
34+
run: npx eslint temp/extracted-code_block_1.ts
35+
36+
- name: Clean up
37+
if: always()
38+
run: rm -rf temp

0 commit comments

Comments
 (0)