Addition to documentation and other minor improvements (#491) #993
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
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| name: CI | |
| concurrency: | |
| group: ${{ github.ref }}-${{ github.workflow }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Rust on ${{ matrix.os }} | |
| if: github.event.pull_request.draft == false | |
| needs: [fmt, clippy] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - macos-latest | |
| - ubuntu-latest | |
| - windows-latest | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| - name: Install dependencies on Ubuntu | |
| if: startsWith(matrix.os, 'ubuntu') | |
| run: | | |
| sudo apt-get -y update | |
| sudo apt-get -y install clang libwayland-dev libxkbcommon-x11-dev pkg-config libvulkan-dev libxcb-shape0-dev libxcb-xfixes0-dev | |
| - name: Update toolchain | |
| run: | | |
| rustup update --no-self-update | |
| - name: Cache Rust dependencies | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Fetch dependencies | |
| run: cargo fetch | |
| - name: Build | |
| run: cargo build | |
| - name: Run tests | |
| run: cargo test --workspace | |
| - name: Run doc tests | |
| run: cargo test --doc --workspace | |
| fmt: | |
| name: Rustfmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| - name: Update toolchain & add rustfmt | |
| run: | | |
| rustup update | |
| rustup component add rustfmt | |
| - name: Run rustfmt | |
| run: cargo fmt --all --check | |
| clippy: | |
| name: Clippy on ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - macos-latest | |
| - ubuntu-latest | |
| - windows-latest | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| - name: Update toolchain & add clippy | |
| run: | | |
| rustup update --no-self-update | |
| rustup component add clippy | |
| - name: Install dependencies on Ubuntu | |
| if: startsWith(matrix.os, 'ubuntu') | |
| run: | | |
| sudo apt-get -y update | |
| sudo apt-get -y install clang libwayland-dev libxkbcommon-x11-dev pkg-config libvulkan-dev | |
| - name: Cache Rust dependencies | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Fetch dependencies | |
| run: cargo fetch | |
| - name: Run clippy | |
| run: cargo clippy -- --deny warnings |