Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions .changeset/20233-stage-8-migration-guidance-tracker-free.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
'@objectstack/spec': patch
---

fix(spec): `os migrate meta` guidance for twenty-four more migration-entry families — `stack-*`, `evaluated-*`, `aggregation-*`, `authoring-*`, `automation-*`, `cache-*`, `tenant-*`, `client-*`, `spec-*`, `cli-*`, `identity-*`, `import-*`, `tool-*`, `advanced-*`, `cloud-*`, `startup-*`, `sys-*`, `declarative-*`, `sort-*`, `address-*`, `packages-*`, `platform-*`, `session-*` and `strategy-*` — states each lesson in words instead of citing tracker numbers

Clause-②: no

The ADR-0087 semantic entries of these twenty-four families are printed by `os migrate meta`
as the header, `why:` and `verify:` lines of a manual change. Their text sent the reader to
issue-tracker, pull-request, decision-batch and summon numbers — some of which no longer
resolve, and some in another repository or a vendor's tracker — for what a ruling,
measurement or fix had decided; it now says what was decided, in the sentence being read.
ADR ids are kept, and so are the rule numbers of this repository's own contributor guide.

Two entries also carried a tracker number in `surface`, the header line itself:
`authoring-schemas-strict-unknown-keys` now names the unknown-key strictness wave, and
`evaluated-expression-slots-source-required` names the census of engine-evaluated slots.
One sentence is corrected while being rewritten: `cli-command-contribution-retired` said the
`manifest.contributes.commands` tombstone was protocol 17; it is registered under protocol 18.

Text only: no entry id, `from` / `to`, conversion or matching logic changes, and the chain
rewrites exactly what it rewrote before. The generated migration registry,
`spec-changes.json` and the protocol upgrade guide carry the same text.
24 changes: 12 additions & 12 deletions docs/protocol-upgrade-guide.md

Large diffs are not rendered by default.

42 changes: 40 additions & 2 deletions packages/cli/test/migrate-meta-engine-guidance.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@
* `metadata-*`, `rest-*`, `analytics-*`, `view-*`, `package-*`, `object-*`,
* `sharing-*`, `audit-*`, `flow-*`, `http-*`, `inline-*`, `actor-*`, `hot-*`,
* `external-*`, `query-*`, `delete-*`, `etl-*`, `storage-*`, `apimethod-*`,
* `dashboard-*`, `notification-*`, `record-*`, `runtime-*`, `rls-*`, `scim-*`)
* states each lesson in words and carries no tracker number.
* `dashboard-*`, `notification-*`, `record-*`, `runtime-*`, `rls-*`, `scim-*`,
* `stack-*`, `evaluated-*`, `aggregation-*`, `authoring-*`, `automation-*`,
* `cache-*`, `tenant-*`, `client-*`, `spec-*`, `cli-*`, `identity-*`,
* `import-*`, `tool-*`, `advanced-*`, `cloud-*`, `startup-*`, `sys-*`,
* `declarative-*`, `sort-*`, `address-*`, `packages-*`, `platform-*`,
* `session-*`, `strategy-*`) states each lesson in words and carries no
* tracker number.
*
* ## What this pins
*
Expand Down Expand Up @@ -87,6 +92,10 @@ const COVERED_PREFIXES = [
'actor-', 'hot-', 'external-', 'query-', 'delete-', 'etl-', 'storage-',
'apimethod-', 'dashboard-', 'notification-', 'record-', 'runtime-', 'rls-',
'scim-',
'stack-', 'evaluated-', 'aggregation-', 'authoring-', 'automation-', 'cache-',
'tenant-', 'client-', 'spec-', 'cli-', 'identity-', 'import-', 'tool-',
'advanced-', 'cloud-', 'startup-', 'sys-', 'declarative-', 'sort-', 'address-',
'packages-', 'platform-', 'session-', 'strategy-',
];

/**
Expand All @@ -101,6 +110,9 @@ const REWRITTEN = [
'action-engine-facade-find-query-envelope',
'action-session-roles-to-positions',
'actor-user-roles-to-positions',
'address-location-value-unknown-keys-refused',
'advanced-plugin-lifecycle-config-retired',
'aggregation-node-distinct-retired',
'analytics-authorable-unknown-keys-refused',
'analytics-date-range-array-two-bounds-required',
'analytics-query-request-envelope-retired',
Expand All @@ -112,6 +124,14 @@ const REWRITTEN = [
'apimethod-enum-shrink',
'audit-log-action-enum-retired',
'audit-log-action-restore-retired',
'authoring-schemas-strict-unknown-keys',
'automation-flow-list-route-retired',
'automation-runs-cursor-retired',
'cache-warmup-scheduled-strategy-retired',
'cli-command-contribution-retired',
'client-delete-result-success',
'client-meta-reset-result-reset',
'cloud-subpath-retired',
'dashboard-header-modal-target-page-only',
'dashboard-widget-chart-config-structure-refused',
'dashboard-widget-compareto-offset',
Expand All @@ -134,6 +154,7 @@ const REWRITTEN = [
'datasource-config-url-userinfo-refused',
'datasource-credentialsref-mongo-composed-no-username-refused',
'datasource-credentialsref-mongo-url-no-user-refused',
'declarative-apis-endpoints-live',
'delete-by-id-before-hook-repoint-retired',
'driver-aggregate-undeclared-key-aliases-removed',
'driver-capabilities-inert-bits-removed',
Expand All @@ -151,6 +172,7 @@ const REWRITTEN = [
'engine-find-formula-order-by-refused',
'engine-update-upsert-retired',
'etl-pipeline-layer-retired',
'evaluated-expression-slots-source-required',
'export-axis-opt-in',
'export-field-meta-constraints-retired',
'export-job-family-retired',
Expand Down Expand Up @@ -185,6 +207,8 @@ const REWRITTEN = [
'hot-reload-watch-placeholder-retired',
'http-request-errors-total-retired',
'http-server-runtime-vocabulary-retired',
'identity-api-key-schema-retired',
'import-run-automations-declared-default-corrected',
'inline-grid-column-currency-scale-refused',
'kernel-compatibility-matrix-estimated-migration-time-unit-in-key',
'kernel-context-preview-mode-retired',
Expand All @@ -209,6 +233,8 @@ const REWRITTEN = [
'package-install-request-unknown-keys-refused',
'package-rollback-response-retired',
'package-uninstall-explicit-all-tenants',
'packages-list-pagination-retired',
'platform-timezone-columns-iana-domain-refused',
'plugin-activation-events-retired',
'plugin-auto-restart-never-reinitialised',
'plugin-manifest-contributes-dead-members-retired',
Expand Down Expand Up @@ -236,9 +262,18 @@ const REWRITTEN = [
'rls-predicate-stored-list-ordering-refused',
'runtime-httpserver-wrapper-retired',
'scim-provider-object-retired',
'session-payload-positions-security-axis',
'session-user-language-retired',
'sharing-execution-context-retired',
'sharing-rule-recipient-reconcile',
'sort-node-direction-rejected',
'spec-type-alias-input-suffix-retired',
'stack-themes-carrier-retired',
'stack-top-level-unknown-keys-refused',
'startup-orchestrator-retired',
'storage-service-list-retired',
'strategy-context-aggregation-method-narrowed',
'sys-account-issuer-retired',
'system-cache-durations-unit-in-key',
'system-collaboration-durations-unit-in-key',
'system-failover-health-check-interval-unit-in-key',
Expand All @@ -249,6 +284,9 @@ const REWRITTEN = [
'system-tracing-otel-exporter-durations-unit-in-key',
'system-tracing-span-duration-unit-in-key',
'system-worker-queue-rate-limit-duration-unit-in-key',
'tenant-schema-cache-ttl-unit-in-key',
'tenant-timeouts-unit-in-key',
'tool-requires-confirmation-retired',
'ui-cloud-connection-widgets-unknown-keys-refused',
'ui-form-field-length-malformed-refused',
'ui-form-field-precision-scale-integer-refused',
Expand Down
Loading
Loading