Merge pull request #100 from dklassic/fix-another-doc-CI #42
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Generate docs | |
on: | |
push: | |
branches: | |
- main | |
- ops/doc # for testing on feature branch | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
env: | |
RUSTC_WRAPPER: sccache | |
CCACHE: sccache | |
SCCACHE_GHA_ENABLED: 'true' | |
LIBCLANG_PATH: /usr/lib/llvm-14/lib | |
steps: | |
- name: Checkout branch | |
uses: actions/checkout@v4 | |
- name: Install Rust | |
uses: dsherret/rust-toolchain-file@v1 | |
- name: Install dependencies | |
run: | | |
sudo apt-get update | |
sudo apt install build-essential python3-pip ccache clang cmake curl \ | |
g++ git gperf libdbus-1-dev libfreetype6-dev libgl1-mesa-dri \ | |
libgles2-mesa-dev libglib2.0-dev libgstreamer-plugins-base1.0-dev \ | |
gstreamer1.0-plugins-good libgstreamer-plugins-good1.0-dev \ | |
gstreamer1.0-plugins-bad libgstreamer-plugins-bad1.0-dev \ | |
gstreamer1.0-plugins-ugly gstreamer1.0-plugins-base \ | |
libgstreamer-plugins-base1.0-dev gstreamer1.0-libav \ | |
libgstrtspserver-1.0-dev gstreamer1.0-tools libges-1.0-dev \ | |
libharfbuzz-dev liblzma-dev libunwind-dev libunwind-dev libvulkan1 \ | |
libx11-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev \ | |
libxmu-dev libxmu6 libegl1-mesa-dev llvm-dev m4 xorg-dev sway \ | |
python3-mako | |
- name: Run sccache-cache | |
uses: Mozilla-Actions/[email protected] | |
- name: Configure cache | |
uses: Swatinem/rust-cache@v2 | |
- name: Clean docs folder | |
run: cargo clean --doc | |
- name: Build docs | |
run: cargo doc -p verso --no-deps | |
- name: Remove lock file | |
run: rm target/doc/.lock | |
- name: Upload `doc` | |
uses: actions/upload-artifact@v4 | |
with: | |
name: doc | |
path: target/doc | |
deploy: | |
if: github.repository_owner == 'versotile-org' | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Checkout `docs` repository | |
uses: actions/checkout@v4 | |
with: | |
repository: versotile-org/docs.versotile.org | |
ssh-key: ${{ secrets.DOCS_DEPLOY_KEY }} | |
ref: docs | |
- name: Clean up docs directory | |
run: | | |
cp {docs/,}index.html | |
rm -r docs/* | |
mv index.html docs/ | |
cp CNAME docs/ | |
- name: Download `doc` | |
uses: actions/download-artifact@v4 | |
with: | |
name: doc | |
path: docs | |
- name: Configure Git | |
run: | | |
git config user.name 'github-actions[bot]' | |
git config user.email 'github-actions[bot]@users.noreply.github.com' | |
- name: Commit and push | |
run: | | |
git add docs | |
git commit -m ":rocket: update docs from \`verso\` repository" | |
git push origin docs |