Skip to content

Use keys for plugin manifest tabs and admin pages - #9

Merged
gabek merged 2 commits into
mainfrom
gek/plugin-manifest-maps
Aug 2, 2026
Merged

Use keys for plugin manifest tabs and admin pages#9
gabek merged 2 commits into
mainfrom
gek/plugin-manifest-maps

Conversation

@gabek

@gabek gabek commented Aug 2, 2026

Copy link
Copy Markdown
Member

This changes plugin manifest tabs and admin pages from arrays with repeated identifiers to objects keyed by those identifiers.

  • Parse tabs by tab slug and admin.pages by plugin-relative path
  • Reject legacy per-value slug and path members and duplicate keys
  • Update pluginhost consumers, admin types, examples, and manifest documentation
Focused verification passed for issue #5087.

I ran the core Go tests and web production build. The keyed manifest examples and admin page flow were also exercised through the plugin scenario and browser checks.

This branch is based on the SQL SDK change already on the stack where required. It does not change unrelated plugin behavior.

Fixes owncast/owncast#5087

Copilot AI review requested due to automatic review settings August 2, 2026 01:00

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the SDK templates, examples, and documentation to reflect the new keyed manifest shape for viewer tabs (manifest.tabs) and admin pages (manifest.admin.pages), replacing the legacy array-of-objects form.

Changes:

  • Updated JS/Python create-owncast-plugin skills to document tabs and admin.pages as identifier-keyed objects.
  • Migrated example manifests and example docs (READMEs/INSTRUCTIONS) to the keyed tabs / keyed admin.pages format.
  • Updated protocol/author documentation to describe keyed shapes and ordering expectations.

Reviewed changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated no comments.

Show a summary per file
File Description
sdks/python/owncast_plugin/template/.agents/skills/create-owncast-plugin-py/SKILL.md Updates manifest shape notes for keyed tabs and keyed admin.pages.
sdks/js/create-owncast-plugin/template/.agents/skills/create-owncast-plugin-js/SKILL.md Updates manifest shape notes for keyed tabs and keyed admin.pages.
rules-tab/plugin.manifest.json Converts tabs and admin.pages to keyed-object form.
examples/python/theme-hub/plugin.manifest.json Converts admin.pages to keyed-object form.
examples/python/tabs-demo/README.md Updates documentation and JSON snippet for keyed tabs.
examples/python/tabs-demo/plugin.manifest.json Converts tabs to keyed-object form.
examples/python/tabs-demo/INSTRUCTIONS.md Updates explanation text for keyed tabs and emitted tab keys.
examples/python/README.md Updates reference from manifest.tabs[] to manifest.tabs.
examples/python/page-content-demo/README.md Updates JSON snippet for keyed tabs.
examples/python/page-content-demo/plugin.manifest.json Converts tabs to keyed-object form.
examples/python/page-content-demo/INSTRUCTIONS.md Updates JSON snippet for keyed tabs.
examples/python/manual-video-settings/README.md Updates JSON snippet for keyed admin.pages.
examples/python/manual-video-settings/plugin.manifest.json Converts admin.pages to keyed-object form.
examples/python/file-manager/plugin.manifest.json Converts admin.pages to keyed-object form.
examples/python/admin-demo/plugin.manifest.json Converts admin.pages to keyed-object form (multiple pages).
examples/python/action-buttons/plugin.manifest.json Converts admin.pages to keyed-object form.
examples/js/theme-hub/plugin.manifest.json Converts admin.pages to keyed-object form.
examples/js/tabs-demo/README.md Updates documentation and JSON snippet for keyed tabs.
examples/js/tabs-demo/plugin.manifest.json Converts tabs to keyed-object form.
examples/js/tabs-demo/INSTRUCTIONS.md Updates explanation text for keyed tabs and emitted tab keys.
examples/js/rules-tab/plugin.manifest.json Converts tabs and admin.pages to keyed-object form.
examples/js/README.md Updates reference from manifest.tabs[] to manifest.tabs.
examples/js/page-content-demo/README.md Updates JSON snippet for keyed tabs.
examples/js/page-content-demo/plugin.manifest.json Converts tabs to keyed-object form.
examples/js/page-content-demo/INSTRUCTIONS.md Updates JSON snippet for keyed tabs.
examples/js/manual-video-settings/README.md Updates JSON snippet for keyed admin.pages.
examples/js/manual-video-settings/plugin.manifest.json Converts admin.pages to keyed-object form.
examples/js/file-manager/plugin.manifest.json Converts admin.pages to keyed-object form.
examples/js/admin-demo/plugin.manifest.json Converts admin.pages to keyed-object form (multiple pages).
examples/js/action-buttons/plugin.manifest.json Converts admin.pages to keyed-object form.
docs/WIRE_PROTOCOL.md Updates protocol docs for keyed tabs / keyed admin.pages and related permission notes.
docs/PLUGIN_AUTHOR_GUIDE.md Updates author guidance/examples for keyed tabs / keyed admin.pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gabek
gabek force-pushed the gek/plugin-manifest-maps branch from 19aacfd to c76ce6a Compare August 2, 2026 03:28
@gabek
gabek merged commit c5dec18 into main Aug 2, 2026
73 checks passed
@gabek
gabek deleted the gek/plugin-manifest-maps branch August 2, 2026 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request (Plugins): Use Tab slugs and AdminPage paths as keys in plugin.manifest.json

2 participants