mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-26 06:39:57 +00:00
acc3b03004
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Chores** - Improved CI workflow for documentation builds by optimizing Rust build settings and updating the runner environment. - Fixed a typo in a workflow step name. - Streamlined caching steps to reduce redundancy and improve efficiency. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
88 lines
2.5 KiB
YAML
88 lines
2.5 KiB
YAML
name: Deploy docs to Pages
|
|
|
|
on:
|
|
push:
|
|
branches: ["main"]
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# Allow one concurrent deployment
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
# This reduces the disk space needed for the build
|
|
RUSTFLAGS: "-C debuginfo=0"
|
|
# according to: https://matklad.github.io/2021/09/04/fast-rust-builds.html
|
|
# CI builds are faster with incremental disabled.
|
|
CARGO_INCREMENTAL: "0"
|
|
|
|
jobs:
|
|
# Single deploy job since we're just deploying
|
|
build:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
- name: Install dependencies needed for ubuntu
|
|
run: |
|
|
sudo apt install -y protobuf-compiler libssl-dev
|
|
rustup update && rustup default
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.10"
|
|
cache: "pip"
|
|
cache-dependency-path: "docs/requirements.txt"
|
|
- uses: Swatinem/rust-cache@v2
|
|
- name: Build Python
|
|
working-directory: python
|
|
run: |
|
|
python -m pip install --extra-index-url https://pypi.fury.io/lancedb/ -e .
|
|
python -m pip install --extra-index-url https://pypi.fury.io/lancedb/ -r ../docs/requirements.txt
|
|
- name: Set up node
|
|
uses: actions/setup-node@v3
|
|
with:
|
|
node-version: 20
|
|
cache: 'npm'
|
|
cache-dependency-path: node/package-lock.json
|
|
- name: Install node dependencies
|
|
working-directory: node
|
|
run: |
|
|
sudo apt update
|
|
sudo apt install -y protobuf-compiler libssl-dev
|
|
- name: Build node
|
|
working-directory: node
|
|
run: |
|
|
npm ci
|
|
npm run build
|
|
npm run tsc
|
|
- name: Create markdown files
|
|
working-directory: node
|
|
run: |
|
|
npx typedoc --plugin typedoc-plugin-markdown --out ../docs/src/javascript src/index.ts
|
|
- name: Build docs
|
|
working-directory: docs
|
|
run: |
|
|
PYTHONPATH=. mkdocs build
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v2
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: "docs/site"
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|