Skip to content
This repository has been archived by the owner on Sep 10, 2024. It is now read-only.

Note in the README #5598

Note in the README

Note in the README #5598

Workflow file for this run

name: Build and deploy the documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
CARGO_TERM_COLOR: always
CARGO_NET_GIT_FETCH_WITH_CLI: "true"
jobs:
build:
name: Build the documentation
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/[email protected]
- name: Install Rust toolchain
run: |
rustup toolchain install stable
rustup default stable
- name: Setup sccache
uses: mozilla-actions/[email protected]
- name: Setup mdBook
uses: peaceiris/[email protected]
with:
mdbook-version: '0.4.37'
- name: Install Node
uses: actions/[email protected]
with:
node-version: 20
- name: Build the documentation
run: sh misc/build-docs.sh
- name: Fix permissions
run: |
chmod -c -R +rX "target/book/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- name: Upload GitHub Pages artifacts
uses: actions/[email protected]
with:
path: target/book/
deploy:
name: Deploy the documentation on GitHub Pages
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main'
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/[email protected]