mirror of
https://github.com/azaion/annotations.git
synced 2026-04-22 11:16:30 +00:00
Sync .cursor from suite (autodev orchestrator + monorepo skills)
This commit is contained in:
Oleksandr Bezdieniezhnykh
@@ -0,0 +1,182 @@
|
||||
---
|
||||
name: monorepo-discover
|
||||
description: Scans a monorepo or meta-repo (git-submodule aggregators, npm/cargo workspaces, etc.) and generates a human-reviewable `_docs/_repo-config.yaml` that other `monorepo-*` skills (document, cicd, onboard, status) read. Produces inferred mappings tagged with evidence; never writes to the config's `confirmed_by_user` flag — the human does that. Use on first setup in a new monorepo, or to refresh the config after structural changes.
|
||||
---
|
||||
|
||||
# Monorepo Discover
|
||||
|
||||
Writes or refreshes `_docs/_repo-config.yaml` — the shared config file that every other `monorepo-*` skill depends on. Does NOT modify any other files.
|
||||
|
||||
## Core principle
|
||||
|
||||
**Discovery is a suggestion, not a commitment.** The skill infers repo structure, but every inferred entry is tagged with `confirmed: false` + evidence. Action skills (`monorepo-document`, `monorepo-cicd`, `monorepo-onboard`) refuse to run until the human reviews the config and sets `confirmed_by_user: true`.
|
||||
|
||||
## Mitigations against LLM inference errors (applies throughout)
|
||||
|
||||
| Rule | What it means |
|
||||
| ---- | ------------- |
|
||||
| **M1** Separation | This skill never triggers other skills. It stops after writing config. |
|
||||
| **M2** Evidence thresholds | No mapping gets recorded without at least one signal (name match, textual reference, directory convention, explicit statement). Zero-signal candidates go under `unresolved:` with a question. |
|
||||
| **M3** Factual vs. interpretive | Resolve factual questions alone (file exists? line says what?). Ask for interpretive ones (does A feed into B?) unless M2 evidence is present. Ask for conventional ones always (commit prefix? target branch?). |
|
||||
| **M4** Batch questions | Accumulate all `unresolved:` questions. Present at end of discovery, not drip-wise. |
|
||||
| **M5** Skip over guess | Never record a zero-evidence mapping under `components:` or `docs:` — always put it in `unresolved:` with a question. |
|
||||
| **M6** Assumptions footer | Every run ends with an explicit list of assumptions used. Also append to `assumptions_log:` in the config. |
|
||||
| **M7** Structural drift | If the config already exists, produce a diff of what would change and ask for approval before overwriting. Never silently regenerate. |
|
||||
|
||||
## Guardrail
|
||||
|
||||
**This skill writes ONLY `_docs/_repo-config.yaml`.** It never edits unified docs, CI files, or component directories. If the workflow ever pushes you to modify anything else, stop.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Phase 1: Detect repo type
|
||||
|
||||
Check which of these exists (first match wins):
|
||||
|
||||
1. `.gitmodules` → **git-submodules meta-repo**
|
||||
2. `package.json` with `workspaces` field → **npm/yarn/pnpm workspace**
|
||||
3. `pnpm-workspace.yaml` → **pnpm workspace**
|
||||
4. `Cargo.toml` with `[workspace]` section → **cargo workspace**
|
||||
5. `go.work` → **go workspace**
|
||||
6. Multiple top-level subfolders each with their own `package.json` / `Cargo.toml` / `pyproject.toml` / `*.csproj` → **ad-hoc monorepo**
|
||||
|
||||
If none match → **ask the user** what kind of monorepo this is. Don't guess.
|
||||
|
||||
Record in `repo.type` and `repo.component_registry`.
|
||||
|
||||
### Phase 2: Enumerate components
|
||||
|
||||
Based on repo type, parse the registry and list components. For each collect:
|
||||
|
||||
- `name`, `path`
|
||||
- `stack` — infer from files present (`.csproj` → .NET, `pyproject.toml` → Python, `Cargo.toml` → Rust, `package.json` → Node/TS, `go.mod` → Go). Multiple signals → pick dominant one. No signals → `stack: unknown` and add to `unresolved:`.
|
||||
- `evidence` — list of signals used (e.g., `[gitmodules_entry, csproj_present]`)
|
||||
|
||||
Do NOT yet populate `primary_doc`, `secondary_docs`, `ci_config`, or `deployment_tier` — those come in Phases 4 and 5.
|
||||
|
||||
### Phase 3: Locate docs root
|
||||
|
||||
Probe in order: `_docs/`, `docs/`, `documentation/`, or a root-level README with links to sub-docs.
|
||||
|
||||
- Multiple candidates → ask user which is canonical
|
||||
- None → `docs.root: null` + flag under `unresolved:`
|
||||
|
||||
Once located, classify each `*.md`:
|
||||
|
||||
- **Primary doc** — filename or H1 names a component/feature
|
||||
- **Cross-cutting doc** — describes repo-wide concerns (architecture, schema, auth, index)
|
||||
- **Index** — `README.md`, `index.md`, or `_index.md`
|
||||
|
||||
Detect filename convention (e.g., `NN_<name>.md`) and next unused prefix.
|
||||
|
||||
### Phase 4: Map components to docs (inference, M2-gated)
|
||||
|
||||
For each component, attempt to find its **primary doc** using the evidence rules. A mapping qualifies for `components:` (with `confirmed: false`) if at least ONE of these holds:
|
||||
|
||||
- **Name match** — component name appears in the doc filename OR H1
|
||||
- **Textual reference** — doc body explicitly names the component path or git URL
|
||||
- **Directory convention** — doc lives inside the component's folder
|
||||
- **Explicit statement** — README, index, or comment asserts the mapping
|
||||
|
||||
No signal → entry goes under `unresolved:` with an A/B/C question, NOT under `components:` as a guess.
|
||||
|
||||
Cross-cutting docs go in `docs.cross_cutting:` with an `owns:` list describing what triggers updates to them. If you can't classify a doc, add an `unresolved:` entry asking the user.
|
||||
|
||||
### Phase 5: Detect CI tooling
|
||||
|
||||
Probe at repo root AND per-component for CI configs:
|
||||
|
||||
- `.github/workflows/*.yml` → GitHub Actions
|
||||
- `.gitlab-ci.yml` → GitLab CI
|
||||
- `.woodpecker/` or `.woodpecker.yml` → Woodpecker
|
||||
- `.drone.yml` → Drone
|
||||
- `Jenkinsfile` → Jenkins
|
||||
- `bitbucket-pipelines.yml` → Bitbucket
|
||||
- `azure-pipelines.yml` → Azure Pipelines
|
||||
- `.circleci/config.yml` → CircleCI
|
||||
|
||||
Probe for orchestration/infra at root:
|
||||
|
||||
- `docker-compose*.yml`
|
||||
- `kustomization.yaml`, `helm/`
|
||||
- `Makefile` with build/deploy targets
|
||||
- `*-install.sh`, `*-setup.sh`
|
||||
- `.env.example`, `.env.template`
|
||||
|
||||
Record under `ci:`. For image tag formats, grep compose files for `image:` lines and record the pattern (e.g., `${REGISTRY}/${NAME}:${BRANCH}-${ARCH}`).
|
||||
|
||||
Anything ambiguous → `unresolved:` entry.
|
||||
|
||||
### Phase 6: Detect conventions
|
||||
|
||||
- **Commit prefix**: `git log --format=%s -50` → look for `[PREFIX]` consistency
|
||||
- **Target/work branch**: check CI config trigger branches; fall back to `git remote show origin`
|
||||
- **Ticket ID pattern**: grep commits and docs for regex like `[A-Z]+-\d+`
|
||||
- **Image tag format**: see Phase 5
|
||||
- **Deployment tiers**: scan root README and architecture docs for named tiers/environments
|
||||
|
||||
Record inferred conventions with `confirmed: false`.
|
||||
|
||||
### Phase 7: Read existing config (if any) and produce diff
|
||||
|
||||
If `_docs/_repo-config.yaml` already exists:
|
||||
|
||||
1. Parse it.
|
||||
2. Compare against what Phases 1–6 discovered.
|
||||
3. Produce a **diff report**:
|
||||
- Entries added (new components, new docs)
|
||||
- Entries changed (e.g., `primary_doc` changed due to doc renaming)
|
||||
- Entries removed (component removed from registry)
|
||||
4. **Ask the user** whether to apply the diff.
|
||||
5. If applied, **preserve `confirmed: true` flags** for entries that still match — don't reset human-approved mappings.
|
||||
6. If user declines, stop — leave config untouched.
|
||||
|
||||
### Phase 8: Batch question checkpoint (M4)
|
||||
|
||||
Present ALL accumulated `unresolved:` questions in one round. For each offer options when possible (A/B/C), open-ended only when no options exist.
|
||||
|
||||
After answers, update the draft config with the resolutions.
|
||||
|
||||
### Phase 9: Write config file
|
||||
|
||||
Write `_docs/_repo-config.yaml` using the schema in [templates/repo-config.example.yaml](templates/repo-config.example.yaml).
|
||||
|
||||
- Top-level `confirmed_by_user: false` ALWAYS — only the human flips this
|
||||
- Every entry has `confirmed: <bool>` and (when `false`) `evidence: [...]`
|
||||
- Append to `assumptions_log:` a new entry for this run
|
||||
|
||||
### Phase 10: Review handoff + assumptions footer (M6)
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
Generated/refreshed _docs/_repo-config.yaml:
|
||||
- N components discovered (X confirmed, Y inferred, Z unresolved)
|
||||
- M docs located (K primary, L cross-cutting)
|
||||
- CI tooling: <detected>
|
||||
- P unresolved questions resolved this run; Q still open — see config
|
||||
- Assumptions made during discovery:
|
||||
- Treated <path> as unified-docs root (only candidate found)
|
||||
- Inferred `<component>` primary doc = `<doc>` (name match)
|
||||
- Commit prefix `<prefix>` seen in N of last 20 commits
|
||||
|
||||
Next step: please review _docs/_repo-config.yaml, correct any wrong inferences,
|
||||
and set `confirmed_by_user: true` at the top. After that, monorepo-document,
|
||||
monorepo-cicd, monorepo-status, and monorepo-onboard will run.
|
||||
```
|
||||
|
||||
Then stop.
|
||||
|
||||
## What this skill will NEVER do
|
||||
|
||||
- Modify any file other than `_docs/_repo-config.yaml`
|
||||
- Set `confirmed_by_user: true`
|
||||
- Record a mapping with zero evidence
|
||||
- Chain to another skill automatically
|
||||
- Commit the generated config
|
||||
|
||||
## Failure / ambiguity handling
|
||||
|
||||
- Internal contradictions in a component (README references files not in code) → surface to user, stop, do NOT silently reconcile
|
||||
- Docs root cannot be located → record `docs.root: null` and list unresolved question; do not create a new `_docs/` folder
|
||||
- Parsing fails on `_docs/_repo-config.yaml` (existing file is corrupt) → surface to user, stop; never overwrite silently
|
||||
@@ -0,0 +1,172 @@
|
||||
# _docs/_repo-config.yaml — schema and example
|
||||
#
|
||||
# Generated by monorepo-discover. Reviewed by a human. Consumed by:
|
||||
# - monorepo-document (reads docs.* and components.*.primary_doc/secondary_docs)
|
||||
# - monorepo-cicd (reads ci.* and components.*.ci_config)
|
||||
# - monorepo-onboard (reads all sections; writes new component entries)
|
||||
# - monorepo-status (reads all sections; writes nothing)
|
||||
#
|
||||
# Every entry has a `confirmed:` flag:
|
||||
# true = human reviewed and approved
|
||||
# false = inferred by monorepo-discover; needs review
|
||||
# And an `evidence:` list documenting why discovery made the inference.
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Metadata
|
||||
# ---------------------------------------------------------------------------
|
||||
version: 1
|
||||
last_updated: 2026-04-17
|
||||
confirmed_by_user: false # HUMAN ONLY: flip to true after reviewing
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Repo identity
|
||||
# ---------------------------------------------------------------------------
|
||||
repo:
|
||||
name: example-monorepo
|
||||
type: git-submodules # git-submodules | npm-workspaces | cargo-workspace | pnpm-workspace | go-workspace | adhoc
|
||||
component_registry: .gitmodules
|
||||
root_readme: README.md
|
||||
work_branch: dev
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Components
|
||||
# ---------------------------------------------------------------------------
|
||||
components:
|
||||
- name: annotations
|
||||
path: annotations/
|
||||
stack: .NET 10
|
||||
confirmed: true
|
||||
evidence: [gitmodules_entry, csproj_present]
|
||||
primary_doc: _docs/01_annotations.md
|
||||
secondary_docs:
|
||||
- _docs/00_database_schema.md
|
||||
- _docs/00_roles_permissions.md
|
||||
ci_config: annotations/.woodpecker/
|
||||
deployment_tier: api-layer
|
||||
ports:
|
||||
- "5001/http"
|
||||
depends_on: []
|
||||
env_vars:
|
||||
- ANNOTATIONS_DB_URL
|
||||
|
||||
- name: loader
|
||||
path: loader/
|
||||
stack: Python 3.12
|
||||
confirmed: false # inferred, needs review
|
||||
evidence: [gitmodules_entry, pyproject_present]
|
||||
primary_doc: _docs/07_admin.md
|
||||
primary_doc_section: "Model delivery"
|
||||
secondary_docs:
|
||||
- _docs/00_top_level_architecture.md
|
||||
ci_config: loader/.woodpecker/
|
||||
deployment_tier: edge
|
||||
ports: []
|
||||
depends_on: [admin]
|
||||
env_vars: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Documentation
|
||||
# ---------------------------------------------------------------------------
|
||||
docs:
|
||||
root: _docs/
|
||||
index: _docs/README.md
|
||||
file_convention: "NN_<name>.md"
|
||||
next_unused_prefix: "13"
|
||||
|
||||
cross_cutting:
|
||||
- path: _docs/00_top_level_architecture.md
|
||||
owns:
|
||||
- deployment topology
|
||||
- component communication
|
||||
- infrastructure inventory
|
||||
confirmed: true
|
||||
|
||||
- path: _docs/00_database_schema.md
|
||||
owns:
|
||||
- database schema changes
|
||||
- ER diagram
|
||||
confirmed: true
|
||||
|
||||
- path: _docs/00_roles_permissions.md
|
||||
owns:
|
||||
- permission codes
|
||||
- role-to-feature mapping
|
||||
confirmed: true
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# CI/CD
|
||||
# ---------------------------------------------------------------------------
|
||||
ci:
|
||||
tooling: Woodpecker # GitHub Actions | GitLab CI | Woodpecker | Drone | Jenkins | ...
|
||||
service_registry_doc: ci_steps.md
|
||||
orchestration_files:
|
||||
- docker-compose.ci.yml
|
||||
- docker-compose.run.yml
|
||||
- docker-compose.ci-agent-amd64.yml
|
||||
install_scripts:
|
||||
- ci-server-install.sh
|
||||
- ci-client-install.sh
|
||||
- ci-agent-amd64-install.sh
|
||||
env_template: .env.example
|
||||
image_tag_format: "${REGISTRY}/${NAME}:${BRANCH}-${ARCH_TAG}"
|
||||
branch_triggers: [stage, main]
|
||||
expected_files_per_component:
|
||||
- path_glob: "<component>/.woodpecker/build-*.yml"
|
||||
required: at-least-one
|
||||
pipeline_template: |
|
||||
when:
|
||||
branch: [stage, main]
|
||||
labels:
|
||||
platform: arm64
|
||||
steps:
|
||||
- name: build-push
|
||||
image: docker
|
||||
commands:
|
||||
- docker build -f Dockerfile -t localhost:5000/<service>:${CI_COMMIT_BRANCH}-arm .
|
||||
- docker push localhost:5000/<service>:${CI_COMMIT_BRANCH}-arm
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
confirmed: false
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Conventions
|
||||
# ---------------------------------------------------------------------------
|
||||
conventions:
|
||||
commit_prefix: "[suite]"
|
||||
meta_commit_fallback: "[meta]"
|
||||
ticket_id_pattern: "AZ-\\d+"
|
||||
component_naming: lowercase-hyphen
|
||||
deployment_tiers:
|
||||
- edge
|
||||
- remote
|
||||
- operator-station
|
||||
- api-layer
|
||||
confirmed: false
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Unresolved questions (populated by monorepo-discover)
|
||||
# ---------------------------------------------------------------------------
|
||||
# Every question discovery couldn't resolve goes here. Action skills refuse
|
||||
# to touch entries that map to `unresolved:` items until the human resolves them.
|
||||
unresolved:
|
||||
- id: satellite-provider-doc-slot
|
||||
question: "Component `satellite-provider` has no matching doc. Create new file or extend an existing doc?"
|
||||
options:
|
||||
- "new _docs/13_satellite_provider.md"
|
||||
- "extend _docs/11_gps_denied.md with a Satellite section"
|
||||
- "no doc needed (internal utility)"
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Assumptions log (append-only, audit trail)
|
||||
# ---------------------------------------------------------------------------
|
||||
# monorepo-discover appends a new entry each run.
|
||||
# monorepo-document, monorepo-cicd, monorepo-onboard also append their
|
||||
# per-run assumptions here so the user can audit what was taken on faith.
|
||||
assumptions_log:
|
||||
- date: 2026-04-17
|
||||
skill: monorepo-discover
|
||||
run_notes: "Initial discovery"
|
||||
assumptions:
|
||||
- "Treated _docs/ as unified-docs root (only candidate found)"
|
||||
- "Inferred component→doc mappings via name matching for 9/11 components"
|
||||
- "Commit prefix [suite] observed in 14 of last 20 commits"
|
||||
Reference in New Issue
Block a user