docs: Introduce top-level module docs for Rust client crate #1536
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: Test | |
| on: | |
| push: | |
| branches: [main, next] | |
| pull_request: | |
| types: [opened, repoened, synchronize] | |
| jobs: | |
| test: | |
| name: Test Rust ${{matrix.toolchain}} on ${{matrix.os}} | |
| runs-on: ${{matrix.os}}-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| toolchain: [stable, nightly] | |
| os: [ubuntu] | |
| steps: | |
| - uses: actions/checkout@main | |
| - name: Install Rust with ${{matrix.toolchain}} toolchain | |
| run: rustup update --no-self-update ${{ matrix.toolchain }} | |
| - uses: taiki-e/install-action@nextest | |
| - name: make - test | |
| run: make test | |
| doc-tests: | |
| name: doc-tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@main | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }} | |
| - name: Install rust | |
| run: rustup update --no-self-update | |
| - name: Run doc-tests | |
| run: make test-docs | |
| integration-tests: | |
| name: integration-tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@main | |
| - name: Install Rust | |
| run: rustup update --no-self-update | |
| - uses: taiki-e/install-action@nextest | |
| - run: make clean-node | |
| - run: make node | |
| - run: make start-node > /dev/null & | |
| - run: make integration-test-full | |
| - name: Kill miden-node | |
| if: always() | |
| run: make kill-node | |
| integration-tests-web-client: | |
| name: integration-tests-web-client | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@main | |
| - name: Install Rust | |
| run: | | |
| rustup update --no-self-update | |
| rustup target add wasm32-unknown-unknown | |
| - name: Install Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - run: make clean-node | |
| - run: make node | |
| - run: make start-node > /dev/null & | |
| - run: make integration-test-web-client | |
| - name: Kill miden-node | |
| if: always() | |
| run: make kill-node | |
| integration-tests-remote-prover-web-client: | |
| name: integration-tests-remote-prover-web-client | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@main | |
| - name: Install Rust | |
| run: | | |
| rustup update --no-self-update | |
| rustup target add wasm32-unknown-unknown | |
| - name: Install Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - run: make clean-node | |
| - run: make node | |
| - run: make start-node > /dev/null & | |
| - run: make clean-prover | |
| - run: make prover | |
| - run: make start-prover > /dev/null & | |
| - run: make integration-test-remote-prover-web-client | |
| - name: Kill miden-node | |
| if: always() | |
| run: make kill-node | |
| - name: Kill miden-prover | |
| if: always() | |
| run: make kill-prover |