name: Docs on: push: branches: [trunk, "firefox*"] pull_request: env: # This is the MSRV used by all repository infrastructure. REPO_MSRV: "1.96.1" CARGO_INCREMENTAL: false CARGO_TERM_COLOR: always RUST_BACKTRACE: full # Every time a PR is pushed to, cancel any previous jobs. This # makes us behave nicer to github and get faster turnaround times # on PRs that are pushed to multiple times in rapid succession. concurrency: group: ${{github.workflow}}-${{github.ref}} cancel-in-progress: ${{github.event_name == 'pull_request'}} jobs: build: runs-on: ubuntu-24.04 permissions: {} steps: - name: Harden runner uses: step-security/harden-runner@1d88384fd173af6ecb012dfd0264a306b711241a # v2.22.4 with: egress-policy: audit - name: Checkout repo uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: persist-credentials: false - name: Install documentation toolchain run: | rustup toolchain install ${{ env.REPO_MSRV }} --no-self-update --profile=minimal rustup override set ${{ env.REPO_MSRV }} - name: Disable debug symbols shell: bash run: | mkdir -p .cargo cat <> .cargo/config.toml [profile.dev] debug = false EOF - name: Caching uses: step-security/rust-cache@8871c8ba063416da7c32246932ea6ae08700453e # v2.9.2 with: key: doc-build env-vars: ImageVersion save-if: ${{ github.ref == 'refs/heads/trunk' }} - name: Build the docs run: | cargo doc --no-deps --lib --document-private-items env: RUSTDOCFLAGS: --cfg docsrs RUSTC_BOOTSTRAP: 1 - name: Deploy the docs uses: step-security/github-pages-deploy-action@fe9e6f669019bdc4519d0fe69013b428268eb30c # v4.9.0 if: github.ref == 'refs/heads/trunk' with: token: ${{ secrets.WEB_DEPLOY }} folder: target/doc repository-name: gfx-rs/wgpu-rs.github.io branch: master target-folder: doc