mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-06 11:52:57 +00:00
b731a6aed9
- Creates testing files `md_testing.py` and `md_testing.js` for testing python and nodejs code in markdown files in the documentation This listens for HTML tags as well: `<!--[language] code code code...-->` will create a set-up file to create some mock tables or to fulfill some assumptions in the documentation. - Creates a github action workflow that triggers every push/pr to `docs/**` - Modifies documentation so tests run (mostly indentation, some small syntax errors and some missing imports) A list of excluded files that we need to take a closer look at later on: ```javascript const excludedFiles = [ "../src/fts.md", "../src/embedding.md", "../src/examples/serverless_lancedb_with_s3_and_lambda.md", "../src/examples/serverless_qa_bot_with_modal_and_langchain.md", "../src/examples/youtube_transcript_bot_with_nodejs.md", ]; ``` Many of them can't be done because we need the OpenAI API key :(. `fts.md` has some issues with the library, I believe this is still experimental? Closes #170 --------- Co-authored-by: Will Jones <willjones127@gmail.com>
97 lines
2.4 KiB
YAML
97 lines
2.4 KiB
YAML
name: Documentation Code Testing
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- docs/**
|
|
- .github/workflows/docs_test.yml
|
|
pull_request:
|
|
paths:
|
|
- docs/**
|
|
- .github/workflows/docs_test.yml
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
env:
|
|
# Disable full debug symbol generation to speed up CI build and keep memory down
|
|
# "1" means line tables only, which is useful for panic tracebacks.
|
|
RUSTFLAGS: "-C debuginfo=1"
|
|
RUST_BACKTRACE: "1"
|
|
|
|
jobs:
|
|
test-python:
|
|
name: Test doc python code
|
|
runs-on: ${{ matrix.os }}
|
|
strategy:
|
|
matrix:
|
|
python-minor-version: [ "11" ]
|
|
os: ["ubuntu-22.04"]
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: 3.${{ matrix.python-minor-version }}
|
|
cache: "pip"
|
|
cache-dependency-path: "docs/test/requirements.txt"
|
|
- name: Build Python
|
|
working-directory: docs/test
|
|
run:
|
|
python -m pip install -r requirements.txt
|
|
- name: Create test files
|
|
run: |
|
|
cd docs/test
|
|
python md_testing.py
|
|
- name: Test
|
|
run: |
|
|
cd docs/test/python
|
|
for d in *; do cd "$d"; echo "$d".py; python "$d".py; cd ..; done
|
|
test-node:
|
|
name: Test doc nodejs code
|
|
runs-on: ${{ matrix.os }}
|
|
strategy:
|
|
matrix:
|
|
node-version: [ "18" ]
|
|
os: ["ubuntu-22.04"]
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
lfs: true
|
|
- name: Set up Node
|
|
uses: actions/setup-node@v3
|
|
with:
|
|
node-version: ${{ matrix.node-version }}
|
|
cache: 'npm'
|
|
cache-dependency-path: docs/test/package-lock.json
|
|
- name: Install dependecies needed for ubuntu
|
|
if: ${{ matrix.os == 'ubuntu-22.04' }}
|
|
run: |
|
|
sudo apt install -y protobuf-compiler libssl-dev
|
|
- name: Install node dependencies
|
|
run: |
|
|
cd docs/test
|
|
npm cache clean --force
|
|
npm ci
|
|
- name: Rust cache
|
|
uses: swatinem/rust-cache@v2
|
|
- name: Install LanceDB
|
|
run: |
|
|
cd docs/test/node_modules/vectordb
|
|
npm ci
|
|
npm run build
|
|
npm run tsc
|
|
- name: Create test files
|
|
run: |
|
|
cd docs/test
|
|
node md_testing.js
|
|
- name: Test
|
|
run: |
|
|
cd docs/test/node
|
|
for d in *; do cd "$d"; echo "$d".js; node "$d".js; cd ..; done
|