Skip to content

fix(plugin-dev): document repository as string-only in manifest docs #54424

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

Open
Codeturion wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −20
Open

fix(plugin-dev): document repository as string-only in manifest docs #54424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 4 deletions plugins/plugin-dev/skills/plugin-structure/examples/advanced-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,7 @@ enterprise-devops/
"url": "https://company.com/teams/devops"
},
"homepage": "https://docs.company.com/plugins/devops",
"repository": {
"type": "git",
"url": "https://github.com/company/devops-plugin.git"
},
"repository": "https://github.com/company/devops-plugin",
"license": "Apache-2.0",
"keywords": [
"devops",
Expand Down
19 changes: 3 additions & 16 deletions plugins/plugin-dev/skills/plugin-structure/references/manifest-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,28 +132,18 @@ Link to plugin documentation or landing page.

#### repository

**Type**: String (URL) or Object
**Type**: String (URL)
**Example**: `"https://github.com/user/plugin-name"`

Source code repository location.

**String format**:
```json
{
"repository": "https://github.com/user/plugin-name"
}
```

**Object format** (detailed):
```json
{
"repository": {
"type": "git",
"url": "https://github.com/user/plugin-name.git",
"directory": "packages/plugin-name"
}
}
```
The `repository` field accepts a plain URL string only. The npm-style object form (`{"type": "git", "url": "..."}`) is not supported and fails manifest validation with `repository: Invalid input: expected string, received object`.

**Use cases**:
- Source code access
Expand Down Expand Up @@ -495,10 +485,7 @@ Full configuration with all features:
"url": "https://company.com/devops"
},
"homepage": "https://docs.company.com/plugins/devops",
"repository": {
"type": "git",
"url": "https://github.com/company/devops-plugin.git"
},
"repository": "https://github.com/company/devops-plugin",
"license": "Apache-2.0",
"keywords": [
"devops",
Expand Down