From 30bd726720b2a717366fb1c3b6e82a6c21893c78 Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Mon, 18 Mar 2024 22:36:58 -0400 Subject: [PATCH] Add docs deployment workflow --- .github/workflows/docs.yml | 60 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..ce668b8 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,60 @@ +name: Documentation +on: + push: + branches: [main] +permissions: + contents: read + pages: write + id-token: write +concurrency: + group: deploy + cancel-in-progress: false + +jobs: + build-docs: + name: Build docs + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Rust stable + uses: dtolnay/rust-toolchain@stable + + - name: Setup Cargo dependency cache + uses: Swatinem/rust-cache@v2 + with: + shared-key: shared + + - name: Setup Pages + id: pages + uses: actions/configure-pages@v4 + + - name: Clean docs output + run: cargo clean --doc + + - name: Build docs + run: cargo doc --no-deps + + - name: Add redirect + run: echo '

Redirecting to ./dicey/index.html...

' > target/doc/index.html + + - name: Remove lock file + run: rm target/doc/.lock + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: target/doc + + deploy-docs: + name: Deploy docs + needs: build-docs + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4