Update documentation for todc-mem and todc-utils crates #10
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 | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: clippy, rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: clippy | |
| run: cargo clippy --workspace --all-features --all-targets -- -D warnings | |
| - name: rustfmt | |
| run: cargo fmt --all --check | |
| check-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: cargo doc | |
| run: cargo doc --all-features --no-deps | |
| test: | |
| needs: check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: test | |
| run: cargo test --workspace --all-targets | |
| test-shuttle: | |
| needs: [check] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: test todc-mem/snapshot | |
| run: cargo test -p todc-mem --features shuttle --test snapshot --release | |
| test-turmoil: | |
| needs: [check] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: test todc-net/abd_96 | |
| run: cargo test -p todc-net --features turmoil --test abd_95 | |
| coverage: | |
| needs: [check, test, test-shuttle, test-turmoil] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: Generate code coverage | |
| run: | | |
| cargo llvm-cov --no-report --workspace | |
| cargo llvm-cov --no-report -p todc-mem --features shuttle --test snapshot | |
| cargo llvm-cov --no-report -p todc-net --features turmoil --test abd_95 | |
| cargo llvm-cov report --codecov --output-path codecov.json | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| files: codecov.json | |
| fail_ci_if_error: true |