Asset promotion

Promote assets across project branches with promote_assets, carrying metadata and aliases.

from obproject.assets import promote_assets

promote_assets(project, source, target, alias="candidate")

Promote assets from one branch to another by copying metadata pointers (the underlying data is not duplicated). Each promoted instance gets an alias on the target branch for stable referencing. Returns: {"promoted": [...], "errors": [...]} Promoted instances are tagged with aliases that represent lifecycle stages:

# Feature branch merges - model arrives on main as @candidate
promote_assets('my_project', source='feature-v2', target='main')

# Evaluation flow passes - re-alias to @validated
promote_assets('my_project', source='main', target='main',
               asset='classifier', instance='@candidate',
               alias='validated')

# Manual approval - promote to @production
promote_assets('my_project', source='main', target='main',
               asset='classifier', instance='@validated',
               alias='production')

Downstream consumers can then read a specific stage:

model = self.prj.get_model("classifier", instance="@production")

To customize the allowed aliases, add to obproject.toml:

[promotion]
aliases = ["candidate", "validated", "production"]  # default

Add a promote job to your GitHub Actions workflow that runs before teardown when a PR is merged:

promote:
  if: >
    github.event_name == 'pull_request' &&
    github.event.action == 'closed' &&
    github.event.pull_request.merged == true
  steps:
    # ... setup steps ...
    - name: Promote assets to main
      run: |
        BRANCH=${{ github.head_ref }}
        PROJECT=$(yq .project obproject.toml)
        python -c "
        from obproject.assets import promote_assets
        result = promote_assets('$PROJECT', source='$BRANCH', target='main')
        for p in result['promoted']:
            print(f\"Promoted {p['kind']}/{p['name']} with @{p.get('alias', 'candidate')}\")
        "

teardown:
  needs: promote
  # ... existing teardown job ...

This ensures assets are promoted to main with @candidate before the feature branch is torn down.

[dev-assets] and promotion pipelines: [dev-assets] branch = "main" redirects all asset reads to main, which is ideal for consumer flows (dashboards, reports). But in a promotion pipeline where a flow trains a model and then evaluates it on the same branch, reads need to come from the branch that just wrote the asset. Either omit [dev-assets] in promotion projects, or use a try/except fallback to read from the write branch when the asset doesn’t exist on main yet.

Anaconda Platform

Getting Started

Platform Guides