fix(plugin-dev): document repository as string-only in manifest docs#54424
Open
Codeturion wants to merge 1 commit intoanthropics:mainfrom
Open
fix(plugin-dev): document repository as string-only in manifest docs#54424Codeturion wants to merge 1 commit intoanthropics:mainfrom
Codeturion wants to merge 1 commit intoanthropics:mainfrom
Conversation
The plugin manifest schema accepts only a string URL for `repository`.
Object form (npm-style {"type": "git", "url": "..."}) fails install with
`repository: Invalid input: expected string, received object`.
manifest-reference.md documented the field as supporting both, and two
complete-example blocks (one in the same file, one in advanced-plugin.md)
used the object form. Update the docs to string-only and rewrite both
examples to match.
Author
Wider regression checkBeyond the per-instance object-form check in the PR body, ran a repo-wide sweep for anything that depends on the documented (incorrect) object-form
No additional files needed changes; the inconsistency the issue cites was localized to exactly these three locations. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
plugins/plugin-dev/skills/plugin-structure/references/manifest-reference.mddocuments therepositoryfield as accepting both string and object formats. The runtime schema only accepts a string; passing an object fails install withrepository: Invalid input: expected string, received object. The same file (andexamples/advanced-plugin.md) also use the wrong object form in two complete-example blocks. Update the field docs to string-only and rewrite both examples to match.Files changed
plugins/plugin-dev/skills/plugin-structure/references/manifest-reference.md(field docs at the#### repositorysection, plus the full-config example near the end)plugins/plugin-dev/skills/plugin-structure/examples/advanced-plugin.md(full-config example)Verification
Setup. Static check that no object-form
repositoryJSON remains in theplugins/plugin-dev/tree, and that all pre-existing string-formrepositoryinstances are unchanged. Compares the upstreammainversion of the two affected files against the patched versions on this branch usinggit show main:<path>.Details. Run from the fork root:
bash notes/repro-43722/verify.sh(the script is included as a reproduction artifact in the working notes, not in this PR). The check isgrep -rnE '"repository":[[:space:]]*\{' plugins/plugin-devfor object form, andgrep -rnE '"repository":[[:space:]]*"https' plugins/plugin-devfor string form. The runtime install failure was not reproduced in a live harness; the schema mismatch is documented in the issue body and is the canonical justification for the fix.Comparisons.
manifest-reference.md#### repository(line ~150)manifest-reference.mdfull-config example (line ~498)advanced-plugin.mdfull-config example (line ~116)manifest-reference.mdline 142 (string-form example)manifest-reference.mdline 467 (string-form example)examples/standard-plugin.mdline 51plugin-structure/SKILL.mdline 77Pre-fix object-form instances: 3. Post-fix: 0. String-form instances unchanged: 4.
Regression. No previously-correct example was modified. The only content removed is the "Object format (detailed)" subsection and the two object-form example blocks; both replaced with the single supported string form.
Refs
Fixes #43722