Docs: Make github.md a bit clearer #6435
Workflow file for this run
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: build | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| permissions: read-all | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| CARGO_PROFILE_DEV_DEBUG: 0 | |
| jobs: | |
| build: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-13, windows-latest] | |
| cargo_flags: [""] | |
| include: | |
| - os: ubuntu-latest | |
| cargo_flags: "--all-features" | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@0e66bd3e6b38ec0ad5312288c83e47c143e6b09e | |
| with: | |
| toolchain: 1.71 | |
| - name: Build | |
| run: cargo build --workspace --all-targets --verbose ${{ matrix.cargo_flags }} | |
| - name: Test | |
| run: cargo test --workspace --all-targets --verbose ${{ matrix.cargo_flags }} | |
| env: | |
| RUST_BACKTRACE: 1 | |
| check-protos: | |
| name: Check protos | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 | |
| - uses: dtolnay/rust-toolchain@0e66bd3e6b38ec0ad5312288c83e47c143e6b09e | |
| with: | |
| toolchain: stable | |
| - run: sudo apt update && sudo apt-get -y install protobuf-compiler | |
| - name: Generate Rust code from .proto files | |
| run: cargo run -p gen-protos | |
| - name: Check for uncommitted changes | |
| run: git diff --exit-code | |
| rustfmt: | |
| name: Check formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 | |
| - uses: dtolnay/rust-toolchain@0e66bd3e6b38ec0ad5312288c83e47c143e6b09e | |
| with: | |
| toolchain: nightly | |
| components: rustfmt | |
| - run: cargo +nightly fmt --all -- --check | |
| cargo-deny: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| checks: | |
| - advisories | |
| - bans licenses sources | |
| # Prevent sudden announcement of a new advisory from failing ci: | |
| continue-on-error: ${{ matrix.checks == 'advisories' }} | |
| steps: | |
| - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 | |
| - uses: EmbarkStudios/cargo-deny-action@a50c7d5f86370e02fae8472c398f15a36e517bb8 | |
| with: | |
| command: check ${{ matrix.checks }} | |
| clippy-check: | |
| name: Clippy check | |
| permissions: | |
| checks: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 | |
| - uses: dtolnay/rust-toolchain@0e66bd3e6b38ec0ad5312288c83e47c143e6b09e | |
| with: | |
| toolchain: stable | |
| components: clippy | |
| - run: cargo +stable clippy --all-features --workspace --all-targets -- -D warnings |