Skip to content

docs(workflow): surface make regen-all finalizer in contributor docs (ag-hlng #regen-all-discoverability) #659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
boshu2 merged 2 commits into from
May 31, 2026
Merged

docs(workflow): surface make regen-all finalizer in contributor docs (ag-hlng #regen-all-discoverability) #659

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99c47cb
docs(workflow): surface `make regen-all` finalizer in contributor doc…
boshu2 May 31, 2026
481f52f
Merge remote-tracking branch 'origin/main' into chore/ag-hlng-regen-a…
boshu2 May 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/agent-workflow-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ cd cli && make sync-hooks # Sync embedded lib/skills into cli/embedded/

| Script | Purpose |
|--------|---------|
| `make regen-all` | **One-command finalizer** — regenerates *every* derived artifact (skill counts, skill-domain-map, `registry.json`, context-map, embedded skills, CLI reference, cli-surface inventory, codex hashes) after adding a skill/command. Run this instead of hunting the generators one CI round at a time (`ag-jima`, ex-PR #598). |
| `make regen-check` | The no-write companion: runs the matching drift validators (the same gates `contracts-sync` enforces). Green here ⇒ those gates pass in CI. |
| `scripts/ship.sh` | One-knob ship loop — detects inventory changes, runs regen sweep, opens PR |
| `scripts/ci-local-release.sh` | Local release validation gate (run before tagging) |
| `scripts/sync-skill-counts.sh` | Sync skill counts across docs after adding/removing skills |
Expand All @@ -37,6 +39,7 @@ All pushes to `main` run `.github/workflows/validate.yml` (65 jobs). **CI is the

```bash
cd cli && make build && make test # If you changed Go code
make regen-all && make regen-check # If you ADDED/REMOVED a skill or `ao` command (then commit the regenerated files)
cd cli && make sync-hooks # If you changed lib/ or skills/standards/references/
scripts/regen-codex-hashes.sh # If you changed skills-codex/ files
bats tests/scripts/<script-you-touched>.bats # Per-script regression suite
Expand All @@ -58,7 +61,7 @@ Run only the per-tool checks for the surfaces you actually touched. Push, let CI
scripts/sync-skill-counts.sh
```

This updates SKILL-TIERS.md, PRODUCT.md, README.md, docs/SKILLS.md, docs/ARCHITECTURE.md, and using-agentops/SKILL.md. Forgetting this fails the doc-release-gate.
This updates SKILL-TIERS.md, PRODUCT.md, README.md, docs/SKILLS.md, docs/ARCHITECTURE.md, and using-agentops/SKILL.md. Forgetting this fails the doc-release-gate. `make regen-all` runs this **plus** every other derived-artifact generator, so prefer it when adding a skill rather than remembering each script individually.

**Every `references/*.md` must be linked in SKILL.md.** If a file exists in `skills/<name>/references/`, the skill's SKILL.md must contain a markdown link to it or a `Read` instruction referencing it. Use `heal.sh --strict` to check.

Expand Down
Loading