rust.yml

name: Rust CI
on: pull_request

jobs:
  test:
    name: Test Suite
    runs-on: buildjet-16vcpu-ubuntu-2204
    steps:
      - uses: actions/checkout@v4
        with:
          lfs: true
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@stable
      - name: Install nextest
        uses: taiki-e/install-action@nextest
      - name: Load rust cache
        uses: astriaorg/buildjet-rust-cache@v2.5.1
      - name: Run cargo check, failing on warnings
        run: cargo check --release --all-targets
        env:
          # The `-D warnings` option causes an error on warnings;
          # we must duplicate the rustflags from `.cargo/config.toml`.
          RUSTFLAGS: "-D warnings --cfg tokio_unstable"

      # If a dependency was modified, Cargo.lock may flap if not committed.
      - name: Check for diffs
        shell: bash
        run: |
          s="$(git status --porcelain)"
          if [[ -n "$s" ]]; then
              echo "ERROR: found modified files that should be committed:"
              echo "$s"
              git diff | head -n 128
              exit 1
          else
              echo "OK: no uncommitted changes detected"
          fi
      - name: Run tests with nextest
        run: cargo nextest run --release --features migration
        env:
          CARGO_TERM_COLOR: always

  fmt:
    name: Rustfmt
    runs-on: buildjet-16vcpu-ubuntu-2204
    steps:
      - uses: actions/checkout@v4
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - name: Load rust cache
        uses: astriaorg/buildjet-rust-cache@v2.5.1
      - run: cargo fmt --all -- --check

  docs:
    # We use a custom script to generate the index page for https://rustdoc.penumbra.zone,
    # and refactors to rust deps can break that generation. Let's ensure this script exits 0
    # on PRs, but we'll still only deploy after merge into main.
    name: Check that rustdocs build OK
    runs-on: buildjet-16vcpu-ubuntu-2204
    steps:
      - uses: actions/checkout@v4
        with:
          lfs: true
      - name: Install rust toolchain
        # The script for rustdoc build requires nightly toolchain.
        uses: dtolnay/rust-toolchain@nightly
      - name: Load rust cache
        uses: astriaorg/buildjet-rust-cache@v2.5.1
      - name: Build rustdocs
        run: ./deployments/scripts/rust-docs