Configuring SOAP

Environments

[envs]

type

object

properties

  • yml_path

Path to YAML file defining the environment.

type

string

  • env_path

Prefix of the new environment. Defaults to .soap/<name of environment>

type

string

default

None

  • install_current

If True, install the current project in this environment after all dependencies.

type

boolean

default

True

  • additional_channels

Channels to prepend to the environment file’s channel list.

type

array

default

items

type

string

  • additional_dependencies

Packages and constraints to add to the environment file.

type

array

default

items

type

string

additionalProperties

False

Aliases

[aliases]

type

object

properties

  • cmd

The command to alias

type

string

  • chdir

(‘Where to run the command. True for the git repository root directory

default

False

anyOf

type

boolean

type

string

  • env

The environment in which to run this command when the –env argument is not passed.

type

string

default

test

  • description

A description of this command for the –help argument.

type

string

default

  • passthrough_args

If True, SOAP will pass any unrecognised arguments through to the aliased command.

type

boolean

default

False

additionalProperties

False