@octonodes/sdk 0.1.14 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/PLUGINS.md +40 -0
- package/dist/gen/types.gen.d.ts +10 -0
- package/dist/gen/types.gen.d.ts.map +1 -1
- package/dist/plugins/schema/constants.d.ts +4 -0
- package/dist/plugins/schema/constants.d.ts.map +1 -1
- package/dist/plugins/schema/constants.js +5 -1
- package/dist/plugins/schema/constants.js.map +1 -1
- package/dist/plugins/schema/plugin/execution.d.ts +14 -0
- package/dist/plugins/schema/plugin/execution.d.ts.map +1 -1
- package/dist/plugins/schema/plugin-publishing.d.ts +396 -0
- package/dist/plugins/schema/plugin-publishing.d.ts.map +1 -0
- package/dist/plugins/schema/plugin-publishing.js +57 -0
- package/dist/plugins/schema/plugin-publishing.js.map +1 -0
- package/dist/plugins/schema/plugin-sdk/index.d.ts +3 -1
- package/dist/plugins/schema/plugin-sdk/index.d.ts.map +1 -1
- package/dist/plugins/schema/plugin-sdk/index.js +7 -1
- package/dist/plugins/schema/plugin-sdk/index.js.map +1 -1
- package/dist/plugins/schema/plugin-version.d.ts +8 -0
- package/dist/plugins/schema/plugin-version.d.ts.map +1 -0
- package/dist/plugins/schema/plugin-version.js +61 -0
- package/dist/plugins/schema/plugin-version.js.map +1 -0
- package/dist/plugins/schema/plugin.d.ts +10 -0
- package/dist/plugins/schema/plugin.d.ts.map +1 -1
- package/dist/plugins/schema/plugin.js +6 -0
- package/dist/plugins/schema/plugin.js.map +1 -1
- package/dist/plugins/sdk/plugins/index.d.ts +2 -0
- package/dist/plugins/sdk/plugins/index.d.ts.map +1 -1
- package/dist/plugins/sdk/plugins/index.js +10 -1
- package/dist/plugins/sdk/plugins/index.js.map +1 -1
- package/package.json +1 -1
package/PLUGINS.md
CHANGED
|
@@ -324,3 +324,43 @@ inventories, project override precedence, npm argument/default behavior,
|
|
|
324
324
|
workflow runtime integrity, artifact relocation, and existing installation flows.
|
|
325
325
|
Decorators, executable configuration, multiple plugins in one package, custom
|
|
326
326
|
canvas renderers, and another manifest format remain outside this contract.
|
|
327
|
+
|
|
328
|
+
## Release files and GitHub publishing
|
|
329
|
+
|
|
330
|
+
SDK/CLI `0.2.0` supports `plugin.octonode.json`, `.yml`, and `.yaml` beside
|
|
331
|
+
`octonode.plugin.ts`. Keep exactly one release file. For example:
|
|
332
|
+
|
|
333
|
+
```json
|
|
334
|
+
{
|
|
335
|
+
"apiVersion": "octonode.plugin/v1",
|
|
336
|
+
"id": "my-plugin",
|
|
337
|
+
"version": "1.0.0",
|
|
338
|
+
"scope": "public"
|
|
339
|
+
}
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
The ID must match the TypeScript plugin. Release-file version, scope, and optional
|
|
343
|
+
contributors override the corresponding code metadata during compilation. Other
|
|
344
|
+
metadata and all node definitions remain in TypeScript. Scope can be `user`, `public`,
|
|
345
|
+
`team` with `teamId`, or `organization` with `orgId`.
|
|
346
|
+
|
|
347
|
+
`octonodes plugin version patch` updates the release file (also accepts `minor`,
|
|
348
|
+
`major`, or an exact version). `octonodes login` followed by
|
|
349
|
+
`octonodes plugin deploy .` builds, validates, hashes and publishes to
|
|
350
|
+
`https://plugins.octonodes.com`, using your existing account.
|
|
351
|
+
|
|
352
|
+
For automatic releases, connect the GitHub App repository and release-file path
|
|
353
|
+
in **Partner → GitHub publishing**, review its target, and enable publishing.
|
|
354
|
+
Use a GitHub sign-in with `repo` and `read:org` scopes. Installation requires the
|
|
355
|
+
personal account owner or an active organization admin; release review and consent
|
|
356
|
+
also require current repository admin permission.
|
|
357
|
+
Commit the downloaded workflow at `.github/workflows/octonode-publish.yml` (or the
|
|
358
|
+
explicit `workflow` path in your config). It runs
|
|
359
|
+
`octonodes plugin deploy . --github` with GitHub Actions `id-token: write`.
|
|
360
|
+
No marketplace secret is required. Only the authorized default-branch workflow
|
|
361
|
+
can publish; changing the target requires reconnection. Existing versions are
|
|
362
|
+
skipped; new bytes require a new version. Installed project pins remain unchanged.
|
|
363
|
+
|
|
364
|
+
Requires deployment of the corresponding engine/control-plane changes and
|
|
365
|
+
publication of SDK/CLI `0.2.0` or newer. Updating the source or opening a PR does not
|
|
366
|
+
apply production migrations, deploy Workers, or publish npm packages.
|
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -4219,6 +4219,8 @@ export type GetApiMarketplaceResponses = {
|
|
|
4219
4219
|
description?: string;
|
|
4220
4220
|
icon?: string;
|
|
4221
4221
|
author?: string;
|
|
4222
|
+
contributors?: Array<string>;
|
|
4223
|
+
repository?: string | null;
|
|
4222
4224
|
homepage?: string;
|
|
4223
4225
|
category?: string;
|
|
4224
4226
|
tags: Array<string>;
|
|
@@ -4313,6 +4315,8 @@ export type GetApiMarketplacePluginsByIdResponses = {
|
|
|
4313
4315
|
description?: string;
|
|
4314
4316
|
icon?: string;
|
|
4315
4317
|
author?: string;
|
|
4318
|
+
contributors?: Array<string>;
|
|
4319
|
+
repository?: string | null;
|
|
4316
4320
|
homepage?: string;
|
|
4317
4321
|
license?: string;
|
|
4318
4322
|
source: 'marketplace';
|
|
@@ -4434,6 +4438,8 @@ export type GetApiPluginsResponses = {
|
|
|
4434
4438
|
description?: string;
|
|
4435
4439
|
icon?: string;
|
|
4436
4440
|
author?: string;
|
|
4441
|
+
contributors?: Array<string>;
|
|
4442
|
+
repository?: string | null;
|
|
4437
4443
|
homepage?: string;
|
|
4438
4444
|
license?: string;
|
|
4439
4445
|
source: string;
|
|
@@ -4508,6 +4514,8 @@ export type GetApiPluginsSearchResponses = {
|
|
|
4508
4514
|
description?: string;
|
|
4509
4515
|
icon?: string;
|
|
4510
4516
|
author?: string;
|
|
4517
|
+
contributors?: Array<string>;
|
|
4518
|
+
repository?: string | null;
|
|
4511
4519
|
homepage?: string;
|
|
4512
4520
|
license?: string;
|
|
4513
4521
|
source: string;
|
|
@@ -4670,6 +4678,8 @@ export type GetApiPluginsByPluginIdResponses = {
|
|
|
4670
4678
|
description?: string;
|
|
4671
4679
|
icon?: string;
|
|
4672
4680
|
author?: string;
|
|
4681
|
+
contributors?: Array<string>;
|
|
4682
|
+
repository?: string | null;
|
|
4673
4683
|
homepage?: string;
|
|
4674
4684
|
license?: string;
|
|
4675
4685
|
source: string;
|