diff --git a/.github/workflows/mdbook-gh-pages.yml b/.github/workflows/mdbook-gh-pages.yml new file mode 100644 index 0000000..89c8b95 --- /dev/null +++ b/.github/workflows/mdbook-gh-pages.yml @@ -0,0 +1,75 @@ +# Simple workflow for building and deploying a mdBook site to GitHub Pages +name: Deploy mdBook site to GitHub Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: [main] + + # 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 + env: + MDBOOK_VERSION: 0.4.40 + MDBOOK_ADMONISH: 1.17.0 + MDBOOK_ALERTS: 0.6.8 + MDBOOK_MERMAID: 0.14.0 + MDBOOK_PAGETOC: 0.2.0 + MDBOOK_TOC: 0.14.2 + MDBOOK_YML_HEADER: 0.1.4 + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Update Rust toolchains and rustup + run: | + curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh + rustup update + - name: Install mdBook + uses: taiki-e/install-action@v2 + with: + tool: cargo-binstall,mdbook@${{ env.MDBOOK_VERSION }} + - name: Install mdBook processors + uses: taiki-e/install-action@v2 + with: + tool: mdbook-admonish@${{ env.MDBOOK_ADMONISH }},mdbook-alerts@${{ env.MDBOOK_ALERTS }},mdbook-mermaid@${{ env.MDBOOK_MERMAID }},mdbook-pagetoc@${{ env.MDBOOK_PAGETOC }},mdbook-toc@${{ env.MDBOOK_TOC }},mdbook-yml-header@${{ env.MDBOOK_YML_HEADER }} + + - name: Setup Pages + id: pages + uses: actions/configure-pages@v5 + + - name: Build with mdBook + run: mdbook 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