mfahampshire
a70e68c7bd
* Smolmix documentation * Add smolmix docs: landing page, tutorials, and developer page links * Add Exit Gateway services page (NR vs IPR) and link from existing docs * Update auto-generated command and API outputs * Reorg of tutorials and architecture pages * License information + remove TODO from docs.rs visibile comment + reorg readme * Add versions file for doc-wide versioning * Relative -> absolute links * Relative -> absolute links * Update license + add old tutorial code as examples * Streamline smolmix docs * Clippy * Clean up doc comments * Last pass * Add larger file download to list * set new versions * Clippy * Remove blake pin from docs + add version range to root Cargo.toml * Format example logging * Remove crate blocked component * Loose whitespace * Add doc verification script for inline mdx * Formatting * Components regen * Reorg + tighten text * Voicing cohesion pass + remove bloated examples * Voicing cont. * Reduce max download size * Small suggested clarifications * Max/docs voicing consistency (#6769) * Reduce max download size * voicing consistency across docs * New landing order w smolmix * Tweaks * Final tweaks
89 lines
3.1 KiB
YAML
89 lines
3.1 KiB
YAML
name: ci-docs
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches-ignore: [master]
|
|
paths:
|
|
- "documentation/docs/**"
|
|
- "sdk/typescript/packages/sdk/src/**"
|
|
- "sdk/typescript/packages/mix-fetch/src/**"
|
|
- ".github/workflows/ci-docs.yml"
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: arc-linux-latest
|
|
env:
|
|
RUSTUP_PERMIT_COPY_RENAME: 1
|
|
defaults:
|
|
run:
|
|
working-directory: documentation/docs
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
- name: Install Dependencies (Linux)
|
|
run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler git python3 && sudo apt-get update --fix-missing
|
|
- name: Install Python3 modules
|
|
run: sudo apt install -y python3-pandas python3-tabulate
|
|
- name: Install rsync
|
|
run: sudo apt-get install -y rsync
|
|
- uses: rlespinasse/github-slug-action@v3.x
|
|
- name: Setup pnpm
|
|
uses: pnpm/action-setup@v4.2.0
|
|
with:
|
|
version: 9
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 20
|
|
- name: Install Rust toolchain
|
|
uses: actions-rs/toolchain@v1
|
|
with:
|
|
toolchain: ${{ vars.REQUIRED_RUSTC_VERSION }}
|
|
- name: Build all binaries
|
|
uses: actions-rs/cargo@v1
|
|
with:
|
|
command: build
|
|
args: --workspace --release
|
|
|
|
- name: Check if TypeScript SDK source changed
|
|
id: check-ts-sdk
|
|
run: |
|
|
if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -qE '^sdk/typescript/packages/(sdk|mix-fetch)/src/'; then
|
|
echo "changed=true" >> $GITHUB_OUTPUT
|
|
else
|
|
echo "changed=false" >> $GITHUB_OUTPUT
|
|
fi
|
|
working-directory: ${{ github.workspace }}
|
|
|
|
- name: Regenerate TypeDoc API reference
|
|
if: steps.check-ts-sdk.outputs.changed == 'true'
|
|
run: |
|
|
npm install -g typedoc@0.25.13 typedoc-plugin-markdown@4.0.3
|
|
cd ${{ github.workspace }}/sdk/typescript/packages/sdk && typedoc --skipErrorChecking
|
|
cd ${{ github.workspace }}/sdk/typescript/packages/mix-fetch && typedoc --skipErrorChecking
|
|
|
|
- name: Verify doc versions
|
|
run: ${{ github.workspace }}/documentation/scripts/verify-doc-versions.sh
|
|
working-directory: ${{ github.workspace }}
|
|
- name: Install project dependencies
|
|
run: pnpm i
|
|
- name: Generate llms-full.txt
|
|
run: pnpm run generate:llms
|
|
- name: Build project
|
|
run: pnpm run build
|
|
- name: Generate sitemap
|
|
run: npx next-sitemap
|
|
- name: Move files to /dist/
|
|
run: ../scripts/move-to-dist.sh
|
|
|
|
- name: Deploy branch to CI www
|
|
continue-on-error: true
|
|
uses: easingthemes/ssh-deploy@main
|
|
env:
|
|
SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
|
|
ARGS: "-rltgoDzvO --delete"
|
|
SOURCE: "dist/docs/"
|
|
REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
|
|
REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
|
|
TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/docs-nextra-${{ env.GITHUB_REF_SLUG }}
|
|
EXCLUDE: "/node_modules/"
|