Deploy Documentation #2
This file contains hidden or 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
| name: Deploy Documentation | |
| on: | |
| push: | |
| tags: | |
| - 'v*' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| name: Build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Setup pages | |
| id: pages | |
| uses: actions/configure-pages@v5 | |
| - name: Clean docs folder | |
| run: cargo clean --doc | |
| - name: Build docs | |
| run: cargo doc --no-deps | |
| - name: Create root redirect | |
| run: | | |
| cat > target/doc/index.html << 'EOF' | |
| <!DOCTYPE html> | |
| <html> | |
| <head> | |
| <meta http-equiv="refresh" content="0; url=./wut/index.html"> | |
| <script>window.location.href = './wut/index.html';</script> | |
| </head> | |
| <body> | |
| <p>Redirecting to <a href="./wut/index.html">documentation</a>...</p> | |
| </body> | |
| </html> | |
| EOF | |
| - name: Remove lock file | |
| run: rm target/doc/.lock | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: target/doc | |
| deploy: | |
| name: 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 |