fix doc index (#210) #743
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: CI checks | |
| on: | |
| merge_group: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| test: | |
| name: Test on ${{ matrix.os }} with ${{ matrix.feature_set }} features | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| feature_set: [basic, all] | |
| os: [ubuntu-latest, windows-latest, macOS-latest] | |
| include: | |
| - feature_set: basic | |
| features: batch,dev-graph,gadget-traces | |
| - feature_set: all | |
| features: batch,dev-graph,gadget-traces,multicore,test-dev-graph,thread-safe-region,sanity-checks,circuit-params | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| override: false | |
| - name: Run tests | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: test | |
| args: --verbose --release --workspace --no-default-features --features "${{ matrix.features }}" | |
| build: | |
| name: Build target ${{ matrix.target }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| target: | |
| - wasm32-unknown-unknown | |
| - wasm32-wasi | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| override: false | |
| - name: Add target | |
| run: rustup target add ${{ matrix.target }} | |
| - name: cargo build | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: build | |
| args: --no-default-features --features batch,dev-graph,gadget-traces --target ${{ matrix.target }} | |
| bitrot: | |
| name: Bitrot check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| override: false | |
| # Build benchmarks to prevent bitrot | |
| - name: Build benchmarks | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: build | |
| args: --benches --examples --all-features | |
| doc-links: | |
| name: Intra-doc links | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| override: false | |
| - name: cargo fetch | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: fetch | |
| # Ensure intra-documentation links all resolve correctly | |
| # Requires #![deny(intra_doc_link_resolution_failure)] in crates. | |
| - name: Check intra-doc links | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: doc | |
| args: --all --document-private-items | |
| fmt: | |
| name: Rustfmt | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| override: false | |
| - run: rustup component add rustfmt | |
| - uses: actions-rs/cargo@v1 | |
| with: | |
| command: fmt | |
| args: --all -- --check | |