Distribution manifest format Reference the stable bundle manifest fields and verification structure. v0.2.3 distribution current operatorsmaintainersintegratorsai-agents
  1. Foundry docs
  2. Start with Foundry
  3. Reference
  4. Distribution manifest format
v0.2.3 distribution current Public

Distribution manifest format

Reference the stable bundle manifest fields and verification structure.

Owner
Foundry Distribution
Source
distribution/docs/manifest-format.md
Ref
v0.3.1
Policy
release-bound
Component pins for v0.2.3
ComponentRoleVersion
coreruntimev0.1.16
theme-shieldthemev0.1.15
starterreferencev0.1.3
docsreferencev0.1.4
distributiontoolingv0.3.1
restricted-component-1consumer-referencev0.1.5
restricted-component-2consumer-referencev1.1.21

Distribution manifests define a compatible Foundry release bundle.

Goals

  • make compatible repo tags explicit
  • define the verification matrix in one place
  • give sites a stable upgrade target

Schema

Current manifests use schema_version: 1.

Top-level sections:

  • bundle
    • release metadata for the bundle itself
  • components
    • shared repos and reference repos that belong to the bundle
  • verification
    • local repos and commands that must pass before the bundle is considered verified
  • notes
    • human-readable release notes

Component fields

Each entry in components supports:

  • id
  • role
  • repo
  • local
  • version

role is descriptive and does not change verification behavior.

Verification repository fields

Each entry in verification.repositories supports:

  • name
  • path
  • expected_tag
  • require_clean
  • require_head_tag

These let release verification distinguish between:

  • a repo merely containing the required tag
  • a repo currently checked out exactly at the required tag

The path value should normally match a components[].local entry so automation can materialize the bundle into a clean workspace before verifying it.

Verification check fields

Each entry in verification.checks supports:

  • name
  • cwd
  • install_command
  • command

Checks run relative to the workspace root supplied to the verification script. install_command is optional and is intended for dependency installation in a clean cloned workspace before the main verification command runs.

Example

See manifests/stable/v0.2.2.yaml for the current stable bundle example.

Static Pagefind search

Search Foundry documentation

Type at least two characters
Search the full documentation system

Results stay inside this build profile and can be filtered by version, component, audience, and lifecycle.