chore: Update documentation to match current CLI/usage #1180
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: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| Formatting: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| override: true | |
| components: rustfmt | |
| - name: Check format | |
| run: | |
| cargo fmt -- --check | |
| Linting: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| lfs: true | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y librocksdb-dev libsnappy-dev libsqlite3-dev | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| override: true | |
| components: clippy | |
| - name: Setup protoc | |
| uses: arduino/[email protected] | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| cache-directories: | | |
| ~/.cargo/registry/src/**/librocksdb-sys-* | |
| - name: Lint with clippy | |
| uses: actions-rs/clippy-check@v1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| Testing: | |
| needs: Formatting | |
| runs-on: ubuntu-24.04 | |
| services: | |
| # The tests need a postgres server; the data will be loaded later | |
| # after checkout. | |
| postgres: | |
| image: postgres | |
| env: | |
| POSTGRES_DB: uta | |
| POSTGRES_USER: uta_admin | |
| POSTGRES_PASSWORD: uta_admin | |
| options: >- | |
| --health-cmd pg_isready | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 5 | |
| ports: | |
| - 5432:5432 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| lfs: 'true' | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y librocksdb-dev libsnappy-dev libsqlite3-dev | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| override: true | |
| - name: Setup protoc | |
| uses: arduino/[email protected] | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: cargo build | |
| run: cargo build --verbose | |
| - name: cargo test | |
| run: cargo test --verbose | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| key: "covtest" | |
| cache-directories: | | |
| ~/.cargo/registry/src/**/librocksdb-sys-* | |
| - name: Install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: Generate code coverage | |
| run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: lcov.info |