Sitesdependsyaml

Sitesdepends.yaml is a configuration file used in multi-site projects to declare dependencies, build order, and related constraints between sites. Written in YAML, it is intended to be read by deployment pipelines, content orchestration tools, or build systems that manage multiple sites within a single project.

The file serves to coordinate complex workflows across a set of sites. It enables automation to determine the correct build and deployment sequence, propagate version information, and share configuration details between sites. By expressing relationships explicitly, teams can reduce manual intervention and improve repeatability in multi-site releases. The repository or hosting location of each site can also be specified, supporting reproducible builds in diverse environments.

Typical structure and fields are defined by the project, but common elements include:

- site or name: a unique identifier for the site.

- depends_on: a list of other sites that must be built or deployed first.

- version: a version constraint or tag for the site.

- source: repository URL or path where the site’s code or content resides.

- build: optional command or script reference to assemble the site.

- environment: optional environment-specific settings or flags.

Example:

sites:

siteA:

depends_on:

- siteB

version: ">=1.0.0"

source: "[email protected]:org/siteA.git"

build: "npm run build-siteA"

siteB:

depends_on: []

version: "1.2.x"

source: "[email protected]:org/siteB.git"

Relation to YAML-based configuration makes it easy to version, validate, and extend. Common considerations include avoiding circular dependencies, handling version drift, and ensuring secure access to sources.