Skip to content

docs(skills): name the installation-wide uniques stop for a self-hosted os deploy #31428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Nov 8, 2026
+27 −5
Merged

docs(skills): name the installation-wide uniques stop for a self-hosted os deploy #31428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .changeset/31338-platform-skill-global-uniques-stop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
'@objectstack/skills': patch
---

docs(skills): the platform skill names the installation-wide uniques stop on a self-hosted `os deploy`

Clause-②: no
Metadata-protocol: none

`objectstack-platform`'s operations reference: a `use-runtime` target's install refusal now also covers the installation-wide `unique` constraints stop, with its two ways on: rerun with `--confirm-global-uniques` when those constraints are meant platform-wide, else set them `unique: 'organization'`. `os deploy` already accepts the flag; this release only teaches it. Two logger and metrics restatements whose home is `references/plugin-development.md` are cut.
15 changes: 14 additions & 1 deletion scripts/check-skills-token-ratchet.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1144,7 +1144,20 @@ export const CEILINGS = new Map([
// the remainder, +35 measured, raises the row, pinned at the measurement.
// Same maintainer ruling, verbatim and untranslated:
// 「A:先削重复,余额按实测提高」 (ruling record 6513306068 on #27847).
['skills/objectstack-platform/references/operations.md', 3375],
// 3375 -> 3394: the `use-runtime` paragraph's install refusal also names the
// installation-wide uniques stop: rerun with `--confirm-global-uniques` when
// those `unique` constraints are meant platform-wide, else set them
// `unique: 'organization'`. Paid first by deleting restatement in the same
// file (-67 bytes): the Logs bullet's `{ level: 'info', format: 'json' }`
// example (home: references/plugin-development.md § ObjectKernel
// Configuration) and the Metrics bullet's "(per-plugin startup durations)"
// (home: the same file's § Health Monitoring, `Map<name, startup ms>`).
// 13500 -> 13574 bytes (+74 net: -67 cut, +141 added) -> ceil(13574 / 4) =
// 3394; headroom was 0, so the remainder, +19 measured, raises the row,
// pinned at the measurement. Same maintainer ruling, verbatim and
// untranslated: 「A:先削重复,余额按实测提高」 (ruling record 6513306068 on
// #27847).
['skills/objectstack-platform/references/operations.md', 3394],
['skills/objectstack-platform/references/plugin-development.md', 3137],
['skills/objectstack-upgrade/references/examples-upgrade.md', 1197],

Expand Down
7 changes: 3 additions & 4 deletions skills/objectstack-platform/references/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Port resolution is the same for `os dev` and `os start` (both spawn `os serve`):

**`os deploy` exit 1, cloud:** a refusal before any write publishes nothing: log in (`os cloud login`), pick an environment (`--env`; none: create one in the ObjectOS Cloud console), or fix the local build or `manifest.version`. `could not build …: <reason>`: the environment's build failed, it keeps serving the previous one; fix and deploy again. `Timed out after …`: the install is recorded and a failing build reads as pending for minutes; deploy again with a longer `--wait-timeout`, or see the build in the ObjectOS Cloud console.

**A `use-runtime` target** (no `--env`) asks for no cloud login: build, dry-run plan, install, live on `hotLoaded`. Exit 1: a failed build; a dry run refused, unserved (no install-local) or ignored (an older runtime installed: upgrade it); an install refusal (rerun with the `--confirm-access-upgrade` / `--confirm-upgrade <token>` it printed); installed but not loaded (live after a restart).
**A `use-runtime` target** (no `--env`) asks for no cloud login: build, dry-run plan, install, live on `hotLoaded`. Exit 1: a failed build; a dry run refused, unserved (no install-local) or ignored (an older runtime installed: upgrade it); an install refusal (rerun with the `--confirm-access-upgrade` / `--confirm-upgrade <token>` it printed, or `--confirm-global-uniques` if its installation-wide `unique` constraints are meant platform-wide, else set them `unique: 'organization'`); installed but not loaded (live after a restart).

> **Cloud connection & marketplace (`@objectstack/cloud-connection`, ADR-0008/0009):**
> the open runtime-side cloud client; its `MarketplaceInstallLocalPlugin` serves the
Expand Down Expand Up @@ -161,10 +161,9 @@ the other imports: [Using Plugins](./plugin-development.md#using-plugins).
- **Health endpoints:** the HTTP dispatcher exposes `GET /health` and
`GET /ready` under the API prefix.
- **Logs:** plugins log via `ctx.logger`. Logger config is a **kernel
construction** option, not a `defineStack` key:
`new ObjectKernel({ logger: { level: 'info', format: 'json' } })`.
construction** option (`new ObjectKernel({ logger })`), not a `defineStack` key.
- **Metrics:** use the kernel's built-ins — `kernel.getPluginMetrics()`
(per-plugin startup durations) and `await kernel.checkAllPluginsHealth()`.
and `await kernel.checkAllPluginsHealth()`.
There is no `metrics` service and no `@objectstack/plugin-prometheus`.

## Common ops pitfalls
Expand Down
Loading