Add doc comments #162
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: CI | |
| on: | |
| push: | |
| branches: [master, develop] | |
| pull_request: | |
| branches: [master, develop] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| test-base: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Use Nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly-2024-04-25 | |
| override: true | |
| - name: Cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| ~/.cargo/registry/src/**/librocksdb-sys-* | |
| target/ | |
| key: ${{ runner.os }}-test-base-${{ hashFiles('Cargo.toml') }} | |
| - name: Test | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: test | |
| args: --verbose | |
| test-all-features: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Use Nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly-2024-04-25 | |
| override: true | |
| - name: Cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| ~/.cargo/registry/src/**/librocksdb-sys-* | |
| target/ | |
| key: ${{ runner.os }}-test-all-features-${{ hashFiles('Cargo.toml') }} | |
| - name: Test | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: test | |
| args: --verbose --all-features | |
| coverage: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Use Nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly-2024-04-25 | |
| components: llvm-tools-preview | |
| override: true | |
| - name: Cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| ~/.cargo/registry/src/**/librocksdb-sys-* | |
| target/ | |
| key: ${{ runner.os }}-coverage-${{ hashFiles('Cargo.toml') }} | |
| - name: Install Coverage Tooling | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: install | |
| args: cargo-llvm-cov --force | |
| - name: Run Coverage | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: llvm-cov | |
| args: --all-features --workspace --lcov --output-path lcov.info | |
| - name: Upload to codecov.io | |
| uses: codecov/codecov-action@v1 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: lcov.info | |
| fail_ci_if_error: true | |
| format: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Use Nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly-2024-04-25 | |
| components: rustfmt | |
| override: true | |
| - name: Check | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: fmt | |
| args: --all -- --check | |
| clippy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Use Nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly-2024-04-25 | |
| components: clippy | |
| override: true | |
| - name: Cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| ~/.cargo/registry/src/**/librocksdb-sys-* | |
| target/ | |
| key: ${{ runner.os }}-clippy-${{ hashFiles('Cargo.toml') }} | |
| - name: Check | |
| uses: actions-rs/clippy-check@v1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| args: --all-features -- -D warnings | |
| benches: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Use Nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly-2024-04-25 | |
| override: true | |
| - name: Cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| ~/.cargo/registry/src/**/librocksdb-sys-* | |
| target/ | |
| key: ${{ runner.os }}-benches-${{ hashFiles('Cargo.toml') }} | |
| - name: Run Benches | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: bench |