Update scope to match render pass #409
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: Docs | |
| on: | |
| push: | |
| branches-ignore: [ | |
| # Branches with the `gh-readonly-queue` prefix are used by the | |
| # merge queue, so they are already covered by the `merge_group` event. | |
| "gh-readonly-queue/**", | |
| ] | |
| pull_request: | |
| merge_group: | |
| env: | |
| # This is the MSRV used by all repository infrastructure. | |
| REPO_MSRV: "1.93" | |
| 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-latest | |
| permissions: {} | |
| steps: | |
| - 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 <<EOF >> .cargo/config.toml | |
| [profile.dev] | |
| debug = false | |
| EOF | |
| - name: Caching | |
| uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1 | |
| 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: JamesIves/github-pages-deploy-action@fa24774553152dd7873cd16ebd8d959b010c5445 # 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 |