dreampiler/kandev
1
0
Fork 0
Code Issues 43 Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: correct plugin-registry CI validation claims

Browse Source 
The registry index-build workflow does not validate plugins.yaml against
schema.json, nor does build-index.mjs compare the entry id to the
manifest id — bad entries are skipped-and-logged, and CI only fails when
a non-empty list resolves to zero built entries. Reword the submission
steps (in both the marketplace docs page and plugin-registry/README.md)
to describe what the workflow actually does: it resolves each entry
against the GitHub API and requires a correctly named
<id>-<version>.tar.gz release asset, with maintainer approval as the real
gate. Also clarify that plugins.yaml `categories` are free-form curation
tags, not the manifest's category enum.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Kandev Agent
2026-07-19 17:29:21 +01:00
parent b0382e77ae
commit 210ed67bca
2 changed files with 24 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/public/plugins-marketplace.md
+14 -7
View File
@@ -144,13 +144,20 @@ a PR that lists it.
categories: [productivity] # optional
```
`id` must match your manifest `id` and be unique in the file. `featured` is a
maintainer-only pin — leave it out of submissions.
2. Open a pull request. CI validates `plugins.yaml` against
[`plugin-registry/schema.json`](https://github.com/kdlbs/kandev/blob/main/plugin-registry/schema.json)
and checks that your `id` matches your repo's latest-release manifest `id`.
3. A maintainer reviews and merges. The index-build workflow picks up your entry
and your plugin appears in the in-app catalog on the next build.
`id` must match your manifest `id` and be unique in the file — the index
build looks for a `<id>-<version>.tar.gz` release asset, so a mismatch means
your package can't be resolved. `categories` here are free-form curation tags
for catalog filtering (not the manifest's category enum). `featured` is a
maintainer-only pin — leave it out of submissions. The pointer-list shape is
defined by
[`plugin-registry/schema.json`](https://github.com/kdlbs/kandev/blob/main/plugin-registry/schema.json).
2. Open a pull request. The registry index-build workflow runs on your PR
(build + tests, no Pages deploy), resolving your entry against the GitHub API
— your repo must have a latest release whose assets include the correctly
named `<id>-<version>.tar.gz` package, or the entry can't be built.
3. A maintainer reviews and merges — maintainer approval is what gates the
official catalog. The index-build workflow then picks up your entry and your
plugin appears in the in-app catalog on the next build.
Ranking in the catalog is **GitHub stars only** — there is no download or usage
telemetry to game. Full submission details are in
plugin-registry/README.md
+10 -6
View File
@@ -58,12 +58,16 @@ usage telemetry** — there is no "most installed" metric, by design.
The `id` **MUST match the `id` in your plugin manifest** and be unique across
the file. `repo` is `owner/name`. `featured` is a maintainer-only pin and
should be left out of submissions.
4. **Open a pull request.** CI validates `plugins.yaml` against `schema.json`
and checks that your `id` matches the target repo's latest-release manifest
`id`.
5. **A maintainer reviews and merges.** Once merged, the index-build workflow
picks up your entry and your plugin appears in the in-app catalog on the next
build.
4. **Open a pull request.** The index-build workflow runs on your PR (build +
tests, no Pages deploy) and resolves your entry against the GitHub API — your
repo must have a latest release whose assets include a correctly named
`<id>-<version>.tar.gz` package, or the entry can't be built. `plugins.yaml`
must follow the `schema.json` pointer-list contract, and your `id` must match
your manifest `id` (the index looks for `<id>-<version>.tar.gz`, so a
mismatch means your package can't be resolved).
5. **A maintainer reviews and merges** — maintainer approval is what gates the
official catalog. Once merged, the index-build workflow picks up your entry
and your plugin appears in the in-app catalog on the next build.
## Teams and corporates: host your own source instead