docs: sync documentation with current engine source #2450
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
| on: [push, pull_request] | |
| name: CI | |
| jobs: | |
| check: | |
| name: Check | |
| runs-on: ubuntu-latest | |
| env: | |
| CARGO_TERM_COLOR: always | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| shared-key: native | |
| cache-targets: false | |
| save-if: ${{ github.ref == 'refs/heads/main' }} | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - uses: extractions/setup-just@v2 | |
| - run: just install-debian-deps | |
| - run: cargo check --workspace | |
| check_wasm: | |
| name: Check wasm32 | |
| runs-on: ubuntu-latest | |
| env: | |
| CARGO_TERM_COLOR: always | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| targets: wasm32-unknown-unknown | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| shared-key: wasm | |
| cache-targets: false | |
| save-if: ${{ github.ref == 'refs/heads/main' }} | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - uses: extractions/setup-just@v2 | |
| - run: just lint-wasm | |
| test: | |
| name: Test Suite | |
| runs-on: ubuntu-latest | |
| env: | |
| CARGO_TERM_COLOR: always | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| shared-key: native | |
| cache-targets: false | |
| save-if: ${{ github.ref == 'refs/heads/main' }} | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - uses: extractions/setup-just@v2 | |
| - run: just install-debian-deps | |
| - run: cargo test --lib | |
| fmt: | |
| name: Rustfmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt | |
| - run: cargo fmt --all -- --check | |
| clippy: | |
| name: Clippy | |
| runs-on: ubuntu-latest | |
| env: | |
| CARGO_TERM_COLOR: always | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| shared-key: native | |
| cache-targets: false | |
| save-if: ${{ github.ref == 'refs/heads/main' }} | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - uses: extractions/setup-just@v2 | |
| - run: just install-debian-deps | |
| - run: cargo clippy -- -D warnings | |
| - name: Clippy editor desktop crate | |
| working-directory: apps/editor | |
| run: cargo clippy -p nightshade-editor -- -D warnings | |
| clippy_wasm: | |
| name: Clippy wasm32 | |
| runs-on: ubuntu-latest | |
| env: | |
| CARGO_TERM_COLOR: always | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| targets: wasm32-unknown-unknown | |
| components: clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| shared-key: wasm | |
| cache-targets: false | |
| save-if: ${{ github.ref == 'refs/heads/main' }} | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - uses: extractions/setup-just@v2 | |
| - run: just lint-wasm | |
| - name: Clippy editor wasm crates | |
| working-directory: apps/editor | |
| run: cargo clippy -p worker -p page --target wasm32-unknown-unknown -- -D warnings | |
| deny: | |
| name: cargo-deny | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: EmbarkStudios/cargo-deny-action@v2 | |
| with: | |
| command: check all | |
| trunk: | |
| name: trunk | |
| runs-on: ubuntu-latest | |
| env: | |
| CARGO_TERM_COLOR: always | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| targets: wasm32-unknown-unknown | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| shared-key: wasm | |
| cache-targets: false | |
| save-if: ${{ github.ref == 'refs/heads/main' }} | |
| workspaces: | | |
| . -> target | |
| apps/editor -> target | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - uses: extractions/setup-just@v2 | |
| - name: Download and install Trunk binary | |
| run: wget -qO- https://github.com/trunk-rs/trunk/releases/download/v0.21.14/trunk-x86_64-unknown-linux-gnu.tar.gz | tar -xzf- && mv trunk ~/.cargo/bin/ | |
| - name: Download and install wasm-bindgen binary | |
| run: wget -qO- https://github.com/rustwasm/wasm-bindgen/releases/download/0.2.115/wasm-bindgen-0.2.115-x86_64-unknown-linux-musl.tar.gz | tar -xzf- && mv wasm-bindgen-0.2.115-x86_64-unknown-linux-musl/wasm-bindgen ~/.cargo/bin/ | |
| - name: Download and install wasm-opt binary | |
| run: wget -qO- https://github.com/WebAssembly/binaryen/releases/download/version_123/binaryen-version_123-x86_64-linux.tar.gz | tar -xzf- && mv binaryen-version_123/bin/wasm-opt ~/.cargo/bin/ | |
| - name: Build editor worker | |
| run: just --justfile apps/editor/justfile --working-directory apps/editor worker | |
| - name: Build | |
| run: trunk build --release --config apps/editor/Trunk.toml |