@ryanatkn/orc NPM

orc

a tool for orchestrating many repos 🪄 orc.ryanatkn.com

I maintain a lot of git repos between Felt, Fuz, Gro, and others. Orc is a tool for helping me orchestrate this complexity. It's not orchestration in the Kubernetes or Pulumi sense (maybe it needs a rename). It's an alternative to the monorepo pattern that more loosely couples repos:

enables automations across repos without requiring them to be in the same monorepo
allows management of the same repo in multiple Orc projects
runs automations locally on your machine, giving you full control and visibility

This repo has demo data - I'm using Orc in Spiderspace, Fuz, and Felt's website.

With Orc you can:

fetch metadata about collections of deployments and import it as typesafe JSON (using Gro's public package patterns)
publish a generated docs website for your collections of deployments
import its components to view and interact with deployment collection metadata
publish metadata about your collections of deployments to the web for other users and tools

planned additions:

run updating operations and other workflows from the frontend in dev mode (ultimately, an update all button)

Usage

configure orc.config.ts
Orc calls the GitHub API using the environment variable GITHUB_TOKEN_SECRET for authorization, which is a GitHub token (with "public access" for public repos, no options selected) in either process.env, a project-local .env, or the parent directory at ../.env (currently optional to read public repos, but it's recommended regardless, and you'll need to select options to support private repos)
re-export the gro deployments task by creating $lib/deployments.task.ts with the contents export * from '@ryanatkn/orc/deployments.task.js';
run gro deployments to update the local data

Getting started as a dev? Start with Gro and the Fuz template.

TODO

figure out better automation than manually running gro deployments
show the rate limit info
think about how Orc could better leverage both GitHub Actions and Forgejo Actions without unwieldy compat