Plugin format names and aliases#
Every conda-workspaces plugin registers itself under one canonical
FORMAT string plus zero or more convenience ALIASES. Users can
pass either the canonical name or an alias wherever conda accepts a
format identifier (conda env create --format=..., conda export --format=...).
Naming policy#
conda-workspaces follows the conda-lockfiles
naming policy in its format-aliases
reference:
The canonical
FORMATis versioned when the format has an on-disk schema version byte (for exampleconda-workspaces-lock-v1). Versioned canonical names are stable across future schema bumps. A futurev2gets a siblingconda-workspaces-lock-v2rather than replacingv1in place.Aliases are unversioned shortcuts (for example
conda-workspaces-lock,workspace-lock). They resolve to the current canonical name and may migrate to a newer version later with a deprecation notice.Manifests that have no on-disk schema version of their own (
conda.toml) keep an unversioned canonical name (conda-workspaces) and no aliases.
Registered names#
File |
Canonical |
Aliases |
|---|---|---|
|
|
— |
|
|
|
These constants are defined in
conda_workspaces/env_spec.py (manifest) and
conda_workspaces/lockfile.py (lockfile). plugin.py and
export.py import those definitions to keep the values consistent.
For the normative description of the conda.toml format, including
required fields, types, semantics, the pyproject.toml embedded form,
and the conda.lock schema relationship, see the conda.toml
specification.