Deploy mdBook site to Pages #15
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
| # Sample workflow for building and deploying a mdBook site to GitHub Pages | |
| # | |
| # To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html | |
| # | |
| name: Deploy mdBook site to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main"] | |
| paths: | |
| - 'book.toml' | |
| - 'theme/**' | |
| - 'src/**' | |
| - 'data/**' | |
| # 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: classabbyamp/treeless-checkout-action@v1 | |
| - name: Download latest mdbook, mdbook-toc and mdbook-admonish | |
| run: | | |
| MDBOOK_VERSION="$(basename $(curl -Ls -o /dev/null -w %{url_effective} https://github.com/rust-lang/mdBook/releases/latest))" | |
| wget -q -O- "https://github.com/rust-lang/mdBook/releases/download/${MDBOOK_VERSION}/mdbook-${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz" | tar -xzf - -C . | |
| MDBOOK_TOC_VERSION="$(basename $(curl -Ls -o /dev/null -w %{url_effective} https://github.com/badboy/mdbook-toc/releases/latest))" | |
| wget -q -O- "https://github.com/badboy/mdbook-toc/releases/download/${MDBOOK_TOC_VERSION}/mdbook-toc-${MDBOOK_TOC_VERSION}-x86_64-unknown-linux-gnu.tar.gz" | tar -xzf - -C . | |
| MDBOOK_ADMONISH_VERSION="$(basename $(curl -Ls -o /dev/null -w %{url_effective} https://github.com/tommilligan/mdbook-admonish/releases/latest))" | |
| wget -q -O- "https://github.com/tommilligan/mdbook-admonish/releases/download/${MDBOOK_ADMONISH_VERSION}/mdbook-admonish-${MDBOOK_ADMONISH_VERSION}-x86_64-unknown-linux-gnu.tar.gz" | tar -xzf - -C . | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v4 | |
| - name: Build with mdBook | |
| run: PATH="$GITHUB_WORKSPACE:$PATH" ./book.sh build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./book | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |