A static registry of OpenSCD plugin providers, published as a providers.json
file over GitHub Pages.
This is central location where providers of OpenSCD plugins are listed. Each provider includes a pointer to their curated list of plugins in json form. For example:
{
"prefix": "OE",
"name": "OmicronEnergy Plugins",
"icon": "https://omicronenergyoss.github.io/oscd-explorer/omicronenergy.png",
"description": "OpenSCD Plugins developed (or forked and maintained) by OmicronEnergy.",
"pluginsUrl": "https://omicronenergyoss.github.io/oscd-explorer/omicronenergy.plugins.json"
}This repo contains no application code — only providers.json,
an array of such provider entries. npm run build copies it, as-is, into dist/;
npm run deploy (via oscd-tooling's oscd deploy, which wraps
gh-pages) publishes dist/ to the
deploy branch — the same branch convention used by this org's other repos
(see oscd-gh-workflows).
.github/workflows/pages.yml runs that exact same
npm run build && npm run deploy on every push to main, so pushing to main
republishes automatically. Anyone with push access can also run npm run build
then npm run deploy locally to publish out-of-band, or trigger the workflow
manually (workflow_dispatch).
One-time setup: Settings → Pages → Source: Deploy from a branch, branch
deploy / (root) (created on first deploy).
Once enabled, the file is served at:
https://omicronenergyoss.github.io/oscd-plugins-registry/providers.json
Consumers fetch that URL directly and load each entry's pluginsUrl in turn.
- Edit
providers.jsonand add/update an entry. - Open a PR; once merged to
main, the Pages deploy workflow republishes it automatically. Alternatively, runnpm run build && npm run deploylocally.