docs: Add status and limitations section to README #34
This file contains hidden or 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: | |
| pull_request: | |
| branches: [main, dev] | |
| push: | |
| branches: [main, dev] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| RUST_BACKTRACE: 1 | |
| jobs: | |
| build-and-test: | |
| name: Build & Test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly-2024-12-01 | |
| components: rustfmt, clippy | |
| - name: Cache cargo registry | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cargo/registry | |
| ~/.cargo/git | |
| zkml/target | |
| key: ${{ runner.os }}-cargo-${{ hashFiles('zkml/Cargo.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-cargo- | |
| - name: Check formatting | |
| working-directory: zkml | |
| run: cargo fmt --check || echo "::warning::Code formatting issues found (non-blocking)" | |
| continue-on-error: true | |
| - name: Build zkml library | |
| working-directory: zkml | |
| run: cargo build --lib | |
| - name: Run zkml/testing tests | |
| working-directory: zkml | |
| run: | | |
| echo "Running Merkle root public values test..." | |
| cargo test --test test_merkle_root_public -- --nocapture | |
| echo "Running Merkle tree tests..." | |
| cargo test --test merkle_tree_test -- --nocapture | |
| echo "Running chunk execution tests..." | |
| cargo test --test chunk_execution_test -- --nocapture | |
| echo "Running chunk proof generation test (release mode for speed)..." | |
| cargo test --test chunk_proof_test --release -- --nocapture | |
| - name: Run clippy (warnings only) | |
| working-directory: zkml | |
| run: cargo clippy --lib -- -W clippy::all || echo "::warning::Clippy warnings found (non-blocking)" | |
| continue-on-error: true | |
| # Docker build - only runs when Docker-related files change | |
| docker-build: | |
| name: Docker Build | |
| runs-on: ubuntu-latest | |
| if: | | |
| contains(github.event.pull_request.title, 'docker') || | |
| contains(github.event.pull_request.title, 'Docker') || | |
| contains(github.event.head_commit.message, 'docker') || | |
| contains(github.event.head_commit.message, 'Docker') | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Build dev image | |
| uses: docker/build-push-action@v5 | |
| with: | |
| context: . | |
| target: dev | |
| push: false | |
| cache-from: type=gha | |
| cache-to: type=gha,mode=max | |
| tags: distributed-zkml:dev | |
| # Note: AWS/GPU tests are intentionally excluded from CI to save costs. |