Defame1297
5e232503c4
Why: ADR-0015 established that Microsoft APM (apm.yml + .apm/) should replace this repo's hand-authored plugin.json/marketplace.json model, with those files becoming compiled output of `apm pack` instead of files edited by hand via the (now-retired) plugin-author/marketplace-author skills. Issue #90 was the deferred execution of that decision, gated on #88 (apm tooling) and #89 (apm-native agent-author/skill-author routing). Implementation notes: - All six plugins (bin, core, git, gitea, kyberforge, lint) now carry apm.yml + .apm/{skills,agents,hooks} as their authoring source. Skills moved with a plain git mv (content-identical across targets). Agents were re-authored, not moved: per ADR-0016, .apm/agents/*.agent.md compiles verbatim to both Claude and Copilot, so plugin-scope agents now carry only name/description/model/source_keys -- no tools: field, no Claude-only knobs (isolation, maxTurns, effort, memory, permissionMode). - Root apm.yml registers all 7 marketplace packages (6 local plus mattpocock-skills as a remote entry) under versioning: per_package, matching this repo's existing independent-plugin-versioning practice. - .claude-plugin/marketplace.json and every plugin's plugin.json are now apm-pack-compiled output, verified against the prior hand-maintained content: same names/descriptions/versions/licenses/authors, only cosmetic serialization differences (JSON key order, owner email vs. url, Unicode escaping). - plugin-author and marketplace-author are retired now that apm-based authoring fully replaces their job; kyberforge bumped 1.3.1 -> 1.4.0 for that removal, and the root marketplace catalog bumped 0.3.1 -> 0.3.2 to match, per the version-bump convention now documented in apm-workflow's reference docs instead of a dedicated script (apm has no native version-bump automation). - Fixed hardcoded pre-.apm/ path assumptions across .pre-commit-config.yaml, .pre-commit-hooks.yaml, scripts/check-scope-walkup-sync.sh, scripts/sync-vale-styles.sh, scripts/check-vale-style-sync.sh, six plugins' root plugin.json (stale skills/hooks/agents pointer fields that check-manifests.sh validates), and several tests/*.bats and tests/*.sh fixtures -- including a bats REPO_ROOT relative-path depth bug (10 files, one extra .apm/ directory level to walk up) and a vale probe-path isolation regression introduced mid-fix. - Corrected empirically-wrong assumptions surfaced this session in apm-workflow/apm-install's own reference docs: `apm marketplace package add` does not accept local paths (only owner/repo remote shorthand -- local packages are registered by editing apm.yml's marketplace.packages[] directly); `apm compile` is a consumer-side AGENTS.md/CLAUDE.md generator, not the plugin.json producer, and hard-fails on skill/agent-only packages without --clean; `apm plugin init <name>` nests a stray subdirectory when run with a positional name arg from inside a same-named directory; no native Copilot marketplace output profile exists; .mcp.json is merged into the compiled plugin.json content-aware and target-scoped, with no dependencies.mcp entry needed for simple passthrough; pipx is the correct pip fallback on externally-managed Python environments. - Renamed agent-author's copilot.agent.md template asset to copilot.agent.md.template so apm compile's recursive *.agent.md glob stops misparsing the placeholder template as a real agent primitive. Impact: plugin.json and marketplace.json are compiled artifacts from here on -- editing them by hand is no longer the workflow; edit apm.yml/.apm/ and run apm pack. CONTEXT.md's Plugin/Plugin marketplace glossary entries reflect this. ADR-0001 is marked superseded, ADR-0006 moot, and ADR-0010 updated for the new .apm/agents/ path (project/user scope unaffected, per ADR-0016). Full local verification: claude plugin validate --strict on all 6 plugins, apm audit --ci, apm marketplace check, check-manifests.sh, and the full test suite (165/165 bats, 13/13 shell scripts) all pass clean. Fixes: #90 Refs: #88, #89 ADR: 0015 ADR: 0016 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ub96PyaSRD9BHPktotj1pC
74 lines
4.2 KiB
Markdown
74 lines
4.2 KiB
Markdown
# Plugin-scope agent provenance file moves to `<plugin-root>/sources.md`
|
|
|
|
**Partially supersedes:** ADR-0005 (agent-author dual-provider scaffold) — specifically the
|
|
claim that "both files share a single `agents/sources.md` for provenance." The rest of
|
|
ADR-0005 (dual-provider generation, scope detection, single-root script interface) is
|
|
unaffected and remains in force.
|
|
|
|
**Path update per ADR-0016:** at plugin scope, agent files no longer live at
|
|
`<plugin-root>/agents/<name>.md`. The authoring source is now
|
|
`<plugin-root>/.apm/agents/<name>.agent.md` — a single vendor-neutral file (no dual Claude/
|
|
Copilot pair) compiled to both targets via `apm pack`. See ADR-0016 for why (the field-dropping
|
|
rationale, `tools:` incompatibility, the compiled-output mechanics) — not restated here. This
|
|
ADR's own conclusion is unaffected by that move: the provenance file still belongs at
|
|
`<plugin-root>/sources.md`, outside any directory `claude plugin validate --strict`
|
|
auto-scans, and `.apm/agents/` is, if anything, further removed from plugin-root than the old
|
|
flat `agents/` directory was, so the reasoning below still holds. References below to
|
|
`<plugin-root>/agents/` describe the pre-APM layout in effect when this decision was made.
|
|
**Scope boundary (per ADR-0016):** this path change is plugin scope only. Project scope
|
|
(`.claude/agents/` + `.github/agents/`) and user scope (`~/.claude/agents/` +
|
|
`~/.copilot/agents/`) are unaffected — they are not APM packages and keep the dual-file
|
|
Claude+Copilot pair model this ADR originally described.
|
|
|
|
`claude plugin validate --strict` auto-discovers every `.md` file directly under a plugin's
|
|
`agents/` directory and treats it as an agent definition requiring YAML frontmatter (`name`,
|
|
`description`, etc.). A flat provenance file at `agents/sources.md` — no frontmatter, by
|
|
design, since it is not an agent — fails validation with a missing-frontmatter warning that
|
|
`--strict` promotes to an error.
|
|
|
|
This was first hit in `plugins/git/agents/sources.md` (added by the git-plugin skill suite).
|
|
It failed the `validate-plugins` pre-push hook. The stopgap in commit `0239b00` added
|
|
throwaway agent frontmatter to unblock the push:
|
|
|
|
```yaml
|
|
---
|
|
name: git-agents-sources
|
|
description: Provenance record for the git plugin's agents, not an invokable agent. Do not invoke.
|
|
tools: none
|
|
---
|
|
```
|
|
|
|
That workaround is now reverted — the file no longer lives where it needs to impersonate an
|
|
agent to pass validation.
|
|
|
|
## Considered options
|
|
|
|
**Exclude via an explicit `agents` manifest array (rejected)** — `plugin.json` supports
|
|
`"agents": ["./agents/reviewer.md"]` as an alternative to `"agents": "agents/"`. The
|
|
hypothesis was that listing only real agent files would stop the validator from also
|
|
discovering `sources.md` in the same directory. Tested empirically on a scratch copy of the
|
|
git plugin: `claude plugin validate --strict` still auto-discovered and failed on the
|
|
unlisted `sources.md`, regardless of the explicit array. The manifest field controls what
|
|
Claude Code loads as agents at runtime; it does not control what the validator scans on
|
|
disk. There is no manifest-level or CLI-flag mechanism to exclude a file from `agents/`
|
|
auto-discovery.
|
|
|
|
**Keep the frontmatter workaround permanently (rejected)** — cheapest fix, already applied,
|
|
but semantically wrong: it makes a plain provenance record indistinguishable from a real
|
|
invokable agent to any tooling or UI that lists available agents (e.g. it could appear as a
|
|
callable agent in the `/agents` picker), which is confusing and incorrect.
|
|
|
|
## Consequences
|
|
|
|
- The provenance file moves to `<plugin-root>/sources.md` — a flat file, plugin-root
|
|
relative, sitting outside any directory that Claude Code or its validator auto-scans. No
|
|
frontmatter is needed or added.
|
|
- `agent-author`'s `new-agent.sh` now writes `<root>/sources.md` instead of
|
|
`<root>/agents/sources.md` at plugin scope.
|
|
- `agent-audit`'s `validate-provenance.sh` now looks for `<plugin-root>/sources.md` when
|
|
checking `source_keys` provenance chains.
|
|
- All doc and template references to `agents/sources.md` (agent-author `SKILL.md`,
|
|
agent-audit `SKILL.md`/`README.md`, both provider templates) are updated to `sources.md`.
|
|
- `plugins/git/agents/sources.md` is relocated to `plugins/git/sources.md` and the
|
|
`0239b00` frontmatter workaround is removed.
|