ska-octopus-build-widgets
ska-octopus-build-widgets packages the official tooling used by SKA to turn a
single JSON description into a fully fledged Octopus widget repository. The
project combines a FastAPI-based user interface, a command-line entry point, and
an extensible templating engine that keeps the generated widgets consistent with
Octopus platform standards.
UI overview screenshot
Capabilities at a Glance
Generate production-ready widget repositories in minutes, complete with CI configuration, npm scripts, and Octopus SDK integration.
Work the way you prefer: use the rich browser UI or drive everything from the CLI so the scaffolder fits neatly into automation workflows.
Encode complex widgets using mixed GraphQL operations (polling, streaming, mutations) while keeping configuration types and defaults in sync.
Produce downloadable archives and on-disk directories so you can review or commit the generated sources immediately.
How to Use These Docs
Start with Getting Started for installation guidance and first-run walkthroughs of both interfaces.
Use Test Auto-Build Widget Step when you want to smoke-test a freshly generated widget inside the Octopus dashboard frontend.
Visit Architecture when you need to understand how the inputs are transformed into code, or when extending the scaffolder.
Consult API Reference for module-by-module API documentation.
Track change history and compatibility notes in Changelog and monitor testing status via Test Coverage.
Tip
The documentation mirrors the GitLab pipelines. Following the commands and make targets shown here will prepare your environment exactly as the CI jobs do.