Repository navigation
docs: point docs and examples at v1.1.0 and layer version 30 (#871) #17
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 User Guide to GitHub Pages | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'docs/guide/**' | |
| - '.github/workflows/docs.yaml' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install mdBook | |
| run: | | |
| mkdir -p $HOME/bin | |
| # -f so an HTTP error is an error: without it curl writes the error page to | |
| # the output file and exits 0, and tar then fails with "not in gzip format" | |
| # — the same misleading failure this commit set out to remove. It is also | |
| # what lets --retry see a 5xx as retryable at all. | |
| curl --retry 5 --retry-all-errors --retry-delay 5 -sSLf \ | |
| https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz \ | |
| -o /tmp/mdbook.tar.gz | |
| tar -xz -C $HOME/bin -f /tmp/mdbook.tar.gz | |
| echo "$HOME/bin" >> $GITHUB_PATH | |
| - name: Build book | |
| run: mdbook build | |
| working-directory: docs/guide | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs-site | |
| 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 |