Skip to content

Latest commit

 

History

History
78 lines (57 loc) · 1.99 KB

distribution.md

File metadata and controls

78 lines (57 loc) · 1.99 KB
layout default
title Distribution
description How pathbase example environments are distributed with distman.

Distribution

pathbase includes a dist.json file for use with distman.

The root dist.json distributes:

  • the pathbase Python package
  • several example pathbase.env files under named targets

Disting an Example Flavor

distman already supports target selection from the CLI with -t / --target, so the practical way to choose an example env file is to define a separate target for each example in dist.json.

For example, to distribute the VFX pathbase.env:

dist -t env_vfx

That copies:

examples/vfx/pathbase.env

to:

{DEPLOY_ROOT}/env/pathbase.env

Each of those targets deploys its selected example env file to the same destination. This means the target name selects which example file is disted, while the destination path stays stable for downstream tools.

Token Rules

Each example also has token rules in a rules.json next to its pathbase.env, and a matching conf_* target that deploys them outside env/, which holds only envstack stacks:

Env target Rules target
env_vfx conf_vfx
env_animation conf_animation
env_data_pipeline conf_data_pipeline
env_logs conf_logs
env_ml conf_ml
dist -t env_vfx
dist -t conf_vfx
{DEPLOY_ROOT}/conf/pathbase/rules.json

Point PATHBASE_RULES at that file, and add a tool's own rules after it, e.g. {DEPLOY_ROOT}/conf/<tool>/rules.json.

Why Targets Work Well

  • no special distman flag is required
  • each example stays explicit and discoverable
  • teams can choose which env file to distribute by target name
  • downstream consumers can always read the same deployed env filename
  • additional example flavors can be added later without changing the CLI model