Initial publish v0.1.0: standalone workflow core (corpus + examples + guards)
This commit is contained in:
@@ -0,0 +1,50 @@
|
||||
# octopus-workflow
|
||||
|
||||
Standalone workflow core extracted from the [octopus](https://eightarms.net/Octopus/octopus)
|
||||
agent platform: a **provider-neutral corpus** of agent workflow skills, rules,
|
||||
checklists, templates, and JSON schemas, plus the **drift guards** that keep
|
||||
the corpus internally consistent and publish-ready.
|
||||
|
||||
The corpus does not assume any specific forge (GitHub / Gitea / GitLab),
|
||||
ticketing, or CI system. System-specific behavior lives behind an explicit
|
||||
adapter contract (`core/adapters/`), so the same core can be adopted by any
|
||||
octopus instance — or any other agent platform — with its own adapters.
|
||||
|
||||
## Layout
|
||||
|
||||
| Path | Contents |
|
||||
|---|---|
|
||||
| `core/skills/` | 17 workflow skills (analyze-dag, implement, review-code, verify, release, ...) |
|
||||
| `core/rules/` | Behavioral rule corpus (claim discipline, compaction, routing, artifact addressing, ...) |
|
||||
| `core/checklists/` | Per-stage checklists consumed by the skills |
|
||||
| `core/templates/` | Artifact templates (DAG, iteration docs) |
|
||||
| `core/schemas/` | JSON schemas under the public namespace `https://eightarms.net/octopus-workflow/schemas/` |
|
||||
| `core/adapters/` | Adapter contract: terminology SSOT + Gitea reference implementation |
|
||||
| `core/CORE-MANIFEST.json` | Registry of core↔instance mappings and sync semantics (verbatim / verbatimDir / rewritten / split / core-only) |
|
||||
| `examples/` | Organization-agnostic narrative essays referencing the core |
|
||||
| `guards/` | Standalone drift guards (bun + node stdlib only) |
|
||||
|
||||
## Guards
|
||||
|
||||
Runnable inside this repo with [bun](https://bun.sh), no install step needed:
|
||||
|
||||
```bash
|
||||
bun run check:core-cohesion # corpus structural invariants
|
||||
bun run check:core-p1 # publish-readiness neutrality (no org-internal links)
|
||||
bun run delink:core -- --check # no replaceable org-internal refs remain
|
||||
```
|
||||
|
||||
The instance-side guards (`check-core-parity`, `check-schema-ids`,
|
||||
`check-dangling-refs`, `core-sync.sh`) compare this corpus against a
|
||||
consuming instance's `.octopus/` tree and live in the octopus platform
|
||||
repo, not here.
|
||||
|
||||
## Versioning & compatibility
|
||||
|
||||
See [core/COMPATIBILITY.md](core/COMPATIBILITY.md) for the compatibility
|
||||
matrix between core versions and consuming instances, and
|
||||
[core/MIGRATION.md](core/MIGRATION.md) for adoption batches.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
Reference in New Issue
Block a user