Skip to main content

Artefacts

Artefacts are versioned outputs generated from GitHub-hosted applications.

Concepts

EntityDescription
ApplicationA tracked GitHub repo + branch + path containing a pixi.toml with a generate task
ArtefactA single execution of an application, pinned to a commit, producing output files

Workflow

  1. Link: User links a GitHub repo/branch/path via the UI
  2. Validate: System checks for pixi.toml and generate task
  3. Run: User triggers a run → API creates Artefact, submits Argo Workflow
  4. Execute: Argo clones repo at commit, runs pixi run generate
  5. Report: Workflow calls back to API with status and output file locations
  6. View: User views artefact status, logs, and output files in UI

API Endpoints

MethodEndpointDescription
POST/applicationsRegister an application
GET/applicationsList all applications
DELETE/applications?repo=&branch=&path=Remove application
POST/applications/artefacts/runTrigger a new artefact run
GET/applications/artefacts?repo=&branch=&path=List artefacts
PATCH/applications/artefacts/Update artefact status/files
GET/applications/artefacts//logsFetch workflow logs

Requirements

Applications must have:

  • pyproject.toml or pixi.toml in the target path
  • pixi.lock committed
  • A generate task defined in pixi