@udx/rabbit-repo
v0.1.4
Published
Repository resolution tooling for Rabbit CI
Readme
rabbit-repo
rabbit.ci resolves the GitHub delivery shape of a repository for Rabbit CI.
Run one command in a repository:
rabbit.ciIt writes .rabbit/repo.yaml with repository identity, branch rules,
environments, and workflow triggers.
The generated file is committed with the code. Refresh it when GitHub delivery configuration changes.
.rabbit/context.yaml is legacy and is not read by rabbit.ci.
Status
This is the focused successor to the repository integration work that first
lived in dev.kit. dev.kit remains responsible for broad generated context;
Rabbit CI execution remains in its integrations and backends.
Quick start
Install the CLI globally:
npm install --global @udx/rabbit-repoRun the command from the repository you want to resolve:
rabbit.ci
rabbit.ci --json
rabbit.ci --yamlThe default command writes .rabbit/repo.yaml and prints a short summary.
--json and --yaml print the same resolution without writing a file. GitHub
discovery is read-only and unavailable GitHub data is left empty. Secret and
variable values are never written; only their names are included.
Resolution
The resolution contains executable repository facts:
- branch names and effective GitHub rules;
- organization/repository secret and variable names, plus environment-specific configuration;
- workflow paths, triggers, and workflow-level permissions.
Read the repository resolution, repository discovery and initialization, and dev.kit migration boundary before extending it.
Development
make testProduct context
Rabbit CI helps teams own how software moves—and proves the work as it moves. Its delivery route is repository-centric, policy-governed, and evidence-producing: move fast, protect the path, craft proofs.
