SpacetimeDB's cargo ci

Overview

This document provides an overview of the cargo ci command-line tool, and documentation for each of its subcommands and options.

`cargo ci`

SpacetimeDB CI tasks

This tool provides several subcommands for automating CI workflows in SpacetimeDB.

It may be invoked via cargo ci <subcommand>, or simply cargo ci to run all subcommands in sequence. It is mostly designed to be run in CI environments via the github workflows, but can also be run locally

Usage:

bash

Usage: cargo ci [OPTIONS] [COMMAND]

Options:

--skip: Skip specified subcommands when running all

When no subcommand is specified, all subcommands are run in sequence. This option allows specifying subcommands to skip when running all. For example, to skip the unreal-tests subcommand, use --skip unreal-tests.

--help: Print help (see a summary with '-h')

`test`

Runs tests

Runs rust tests, codegens csharp sdk and runs csharp tests. This does not include Unreal tests. This expects to run in a clean git state.

Usage:

bash

Usage: test

Options:

--help: Print help (see a summary with '-h')

`lint`

Lints the codebase

Runs rustfmt, clippy, csharpier, TypeScript lint, and generates rust docs to ensure there are no warnings.

Usage:

bash

Usage: lint

Options:

--help: Print help (see a summary with '-h')

`wasm-bindings`

Tests Wasm bindings

Runs tests for the codegen crate and builds a test module with the wasm bindings.

Usage:

bash

Usage: wasm-bindings

Options:

--help: Print help (see a summary with '-h')

`dlls`

Deprecated; use cargo regen csharp dlls.

Builds and packs C# DLLs and NuGet packages for local Unity workflows.

Usage:

bash

Usage: dlls

Options:

--help: Print help (see a summary with '-h')

`smoketests`

Runs smoketests

Executes the smoketests suite with some default exclusions.

Usage:

bash

Usage: smoketests [OPTIONS] [ARGS]... [COMMAND]

Options:

--server: Run tests against a remote server instead of spawning local servers.

When specified, tests will connect to the given URL instead of starting local server instances. Tests that require local server control (like restart tests) will be skipped.

--dotnet:
args: Additional arguments to pass to the test runner
--help: Print help (see a summary with '-h')

`prepare`

Only build binaries without running tests

Use this before running cargo test --all to ensure binaries are built.

Usage:

bash

Usage: prepare

Options:

--help: Print help (see a summary with '-h')

`check-mod-list`

Usage:

bash

Usage: check-mod-list

Options:

--help: Print help

`help`

Usage:

bash

Usage: help [COMMAND]...

Options:

subcommand: Print help for the subcommand(s)

`update-flow`

Tests the update flow

Tests the self-update flow by building the spacetimedb-update binary for the specified target, by default the current target, and performing a self-install into a temporary directory.

Usage:

bash

Usage: update-flow [OPTIONS]

Options:

--target: Target triple to build for, by default the current target. Used by github workflows to check the update flow on multiple platforms.
--github-token-auth: Whether to enable github token authentication feature when building the update binary. By default this is disabled.
--help: Print help (see a summary with '-h')

`cli-docs`

Usage:

bash

Usage: cli-docs [OPTIONS]

Options:

--spacetime-path: specify a custom path to the SpacetimeDB repository root (where the main Cargo.toml is located)
--help: Print help (see a summary with '-h')

`self-docs`

Usage:

bash

Usage: self-docs [OPTIONS]

Options:

--check: Only check for changes, do not generate the docs
--help: Print help (see a summary with '-h')

`global-json-policy`

Usage:

bash

Usage: global-json-policy

Options:

--help: Print help

`publish-checks`

Usage:

bash

Usage: publish-checks

Options:

--help: Print help

`typescript-test`

Usage:

bash

Usage: typescript-test

Options:

--help: Print help

`version-upgrade-check`

Usage:

bash

Usage: version-upgrade-check

Options:

--help: Print help

`docs`

Usage:

bash

Usage: docs

Options:

--help: Print help

`help`

Usage:

bash

Usage: help [COMMAND]...

Options:

subcommand: Print help for the subcommand(s)

This document is auto-generated by running:

bash

cargo ci self-docs