Packages

Packages

Zinc packages are local bundles of arbitrary software assets. A package is described by zinc.pkg.yaml; asset names are paths in a navigable tree, not Zinc-specific asset types.

Manifest

name: browser
version: "0.7.0"
about: Browser-backed assets.

assets:
  shapes:
    search_web:
      path: shapes/search-web.circuitry.yaml
  adapter:
    path: bin/browser-harness
  docs:
    readme:
      path: docs/README.md

scripts:
  setup:
    linux: scripts/setup
    macos: scripts/setup
  check:
    linux: scripts/check
    macos: scripts/check
  remove:
    linux: scripts/remove
    macos: scripts/remove

Asset references

Authored YAML uses alias.path.to.asset.

zinc:
  packages:
    browser: browser@0.7.0

uses:
  search:
    shape: browser.shapes.search_web

Model config uses the same reference style.

models:
  default: local
  local:
    adapter: browser.adapter

shape: and adapter: describe how the resolved package file is used. They do not create special package asset classes.

Soft dependencies

soft_dependencies:
  browser: browser-tools@0.1.0

Zinc reports soft dependencies during package inspect and install. References to missing soft dependencies fail when used.