doc: Document k8s/tilt dev setup #7
This file contains 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: rustdoc | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: [ "*" ] | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| CARGO_NET_RETRY: 10 | |
| RUSTFLAGS: "-D warnings -W unreachable-pub" | |
| RUSTDOCFLAGS: "--enable-index-page -Zunstable-options" | |
| RUSTUP_MAX_RETRIES: 10 | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| container: ghcr.io/famedly/rust-container:nightly | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - uses: famedly/backend-build-workflows/.github/actions/rust-prepare@main | |
| with: | |
| gitlab_ssh: ${{ secrets.CI_SSH_PRIVATE_KEY}} | |
| additional_packages: ${{ env.ADDITIONAL_PACKAGES }} | |
| - name: Say nightly version | |
| shell: bash | |
| run: echo "Using Rust nightly version '${NIGHTLY_VERSION}'" | |
| - name: Build Documentation | |
| shell: bash | |
| run: cargo +${NIGHTLY_VERSION} doc --all --no-deps | |
| - name: Fix permissions | |
| shell: bash | |
| run: | | |
| chmod -c -R +rX "target/doc/" | while read line; do | |
| echo "::warning title=Invalid file permissions automatically fixed::$line" | |
| done | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: "target/doc" | |
| deploy: | |
| runs-on: ubuntu-latest | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |