@runloop/api-client - v1.4.0
    Preparing search index...

    Interface Workspace

    A workspace is a buildable unit of code within a repository and often represents a deployable unit of code like a backend service or a frontend app.

    interface Workspace {
        build_tool: string[];
        dev_commands?: DevCommands | null;
        name?: string | null;
        path?: string | null;
        workspace_refresh_commands?: string[] | null;
        workspace_setup_commands?: string[] | null;
    }
    Index

    Properties

    build_tool dev_commands? name? path? workspace_refresh_commands? workspace_setup_commands?

    Properties

    build_tool: string[]

    Name of the build tool used (e.g. pip, npm).

    dev_commands?: DevCommands | null

    Extracted common commands important to the developer life cycle like linting, testing, building, etc.

    name?: string | null

    Name of the workspace. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.

    path?: string | null

    Path to the workspace from the root of the repository. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.

    workspace_refresh_commands?: string[] | null

    Commands to run to refresh this workspace after pulling the latest changes to the repository via git (e.g. npm install).

    workspace_setup_commands?: string[] | null

    Commands to run to setup this workspace after a fresh clone of the repository on a new container such as installing necessary toolchains and dependencies (e.g. npm install).

    Settings

    Member Visibility

    On This Page

    Properties