Skip to main content

Pack manifest file

The pack.yaml manifest of a content pack's source directory.

Fields​

FieldTypeRequiredDescription
descriptionstringRequired
idstringRequiredFormat: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
imagestringOptionalLogo basename next to pack.yaml. No path separators, so it cannot escape the pack directory. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*\.(png|svg|webp)$.
minHamelinVersionstringOptionalLowest Hamelin version an org must be on to install or update to this pack's current content. Omit when the pack needs nothing beyond the platform minimum. Not a monotonic counter like version — it simply reflects what the current content requires. Pattern: ^\d+\.\d+\.\d+$.
namestringRequiredMust not be empty.
stablebooleanOptionalOnce set, the pack must evolve compatibly. Omit while the pack is in preview. Always true.
versionintegerRequiredGreater than 0.

Perpetual CLI 0.5.0