Skip to content

replaced docs build script with a get-lua-ls script #10

replaced docs build script with a get-lua-ls script

replaced docs build script with a get-lua-ls script #10

Workflow file for this run

name: Build & Deploy Docs
on:
# automatically update docs when pushing to master
push:
branches: [ "master" ]
# also allow to run the workflow manually from the actions tab
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
- name: Install Rust
uses: actions-rust-lang/setup-rust-toolchain@v1
- name: Generate API
run: |
cd docs
./generate/get-lua-ls.sh
cargo run -- "../types/nerdo/library" "./src"
- name: Build
run: |
cd docs
cargo install mdbook --no-default-features --features search --vers "^0.4" --locked
cargo install mdbook-linkcheck mdbook-toc mdbook-alerts
mdbook build
- name: Upload
uses: actions/upload-pages-artifact@v3
with:
name: github-pages
path: ./docs/out/html
deploy:
# Add a dependency to the build job
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4