Skip to content

README.md

Latest commit

 

History

History
163 lines (100 loc) · 3.62 KB

README.md

File metadata and controls

163 lines (100 loc) · 3.62 KB

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:

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:

Usage: test

Options:

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

lint

Lints the codebase

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

Usage:

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:

Usage: wasm-bindings

Options:

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

dlls

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

Packs the in-repo C# NuGet packages and restores the C# SDK to populate sdks/csharp/packages/**. Then overlays Unity .meta skeleton files from sdks/csharp/unity-meta-skeleton~/** onto the restored versioned package directory, so Unity can associate stable meta files with the most recently built package.

Usage:

Usage: dlls

Options:

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

smoketests

Runs smoketests

Executes the smoketests suite with some default exclusions.

Usage:

Usage: smoketests [ARGS]...

Options:

  • args: Additional arguments to pass to the smoketests runner. These are usually set by the CI environment, such as -- --docker
  • --help: Print help (see a summary with '-h')

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:

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:

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:

Usage: self-docs [OPTIONS]

Options:

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

help

Usage:

Usage: help [COMMAND]...

Options:

  • subcommand:

This document is auto-generated by running:

cargo ci self-docs