From ba1e2550ddeb694eb5bc9edbd6fe76bc1a85d358 Mon Sep 17 00:00:00 2001 From: max-ishere <47008271+max-ishere@users.noreply.github.com> Date: Wed, 7 Feb 2024 19:00:44 +0200 Subject: [PATCH] ci: Host `cargo doc` on GitHub Pages --- .github/workflows/cargo-doc-pages.yml | 55 +++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/workflows/cargo-doc-pages.yml diff --git a/.github/workflows/cargo-doc-pages.yml b/.github/workflows/cargo-doc-pages.yml new file mode 100644 index 0000000..854adaf --- /dev/null +++ b/.github/workflows/cargo-doc-pages.yml @@ -0,0 +1,55 @@ +name: Deploy `cargo doc` to GitHub Pages + +on: + push: + # branches: + # - main + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + deploy-doc: + runs-on: ubuntu-latest + + environment: + name: github-pages + url: ${{steps.deployment.outputs.page_url}} + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - uses: actions/cache@v4 + with: + path: target/ + key: cargo-doc-${{ hashFiles('Cargo.lock') }} + restore-keys: | + cargo-doc-${{ hashFiles('Cargo.lock') }} + cargo-doc- + cargo- + + + - name: Run `cargo doc` + run: cargo doc --lib --no-deps + + - name: Patch root index.html + run: echo '' > target/doc/index.html + + - name: Upload Artifact + uses: actions/upload-pages-artifact@v1 + with: + path: 'target/doc' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2