35 lines
1.6 KiB
Markdown
35 lines
1.6 KiB
Markdown
# {{PLUGIN_NAME}}
|
|
|
|
{{DESCRIPTION}}
|
|
|
|
Generated by `dbx-plugin create` with the **{{TEMPLATE_LABEL}}** template.
|
|
|
|
## Develop
|
|
|
|
With Node.js 22+ and the backend compiler installed, run the browser development host without DBX:
|
|
|
|
```bash
|
|
dbx-plugin dev --path . --port 5190
|
|
```
|
|
|
|
The CLI builds the backend and loads the declared UI. Optional `[dev]` `ui_build` and `ui_watch` command arrays configure frontend builds. Development credentials are stored as local plaintext in `.dbx-dev/`; keep that directory out of commits and packages. Use the real DBX host for final integration testing.
|
|
|
|
Build an installable candidate:
|
|
|
|
```bash
|
|
dbx-plugin package .
|
|
```
|
|
|
|
The command builds the native backend for the current host, stages `manifest.json`, `assets/`, and `ui/`, then writes an unsigned target-specific `.dbxp` candidate plus matching `.artifact.json` into `dist/`.
|
|
|
|
## Release
|
|
|
|
1. Publish a GitHub Release. The generated workflow builds unsigned candidates for every target.
|
|
2. Open a **Plugin submission Issue** in `t8y2/dbx-store` with the source tag and `release-candidates.json` URL.
|
|
3. After review, DBX Store signs approved candidates with the official repository key and publishes the installable assets.
|
|
4. Open the final catalog PR against **`t8y2/dbx-store:main`** using the signed artifact metadata.
|
|
|
|
Source code and unsigned candidates stay in this repository. DBX users install the DBX Store-signed assets exposed by the official catalog.
|
|
|
|
Do not submit ordinary plugin source to `t8y2/dbx`; that repository accepts plugin host, SDK, CLI, schema, documentation, and official-example changes.
|