From 93d0021391595fc9030ba2349bd88acecd5a899f Mon Sep 17 00:00:00 2001 From: murashit Date: Sat, 18 Jul 2026 08:59:33 +0900 Subject: [PATCH] docs: correct app-server compatibility key --- README.md | 10 +++++----- scripts/api-baseline.mjs | 4 ++-- tests/scripts/development-scripts.test.ts | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 112ab9d2..fac4a30d 100644 --- a/README.md +++ b/README.md @@ -60,11 +60,11 @@ Threads can be archived as Markdown notes with a configurable folder, filename t ## Compatibility -| Key | Version | Policy | -| ------------------------ | --------- | --------------------------------------------------------------------------------------------------- | -| `manifest.minAppVersion` | `1.12.0` | Minimum Obsidian desktop version declared for plugin loading. | -| `obsidian` API types | `1.12.3` | TypeScript API package used for compile-time checks; kept in the same minor as `manifest` baseline. | -| `codex.testedCliVersion` | `0.144.4` | Exact CLI patch used to generate and verify bindings; compatibility is tracked by minor version. | +| Key | Version | Policy | +| -------------------------------------- | --------- | --------------------------------------------------------------------------------------------------- | +| `manifest.minAppVersion` | `1.12.0` | Minimum Obsidian desktop version declared for plugin loading. | +| `obsidian` API types | `1.12.3` | TypeScript API package used for compile-time checks; kept in the same minor as `manifest` baseline. | +| `codexAppServer.testedCliVersion` | `0.144.4` | Exact CLI patch used to generate and verify bindings; compatibility is tracked by minor version. | Codex Panel depends on the experimental `codex app-server` API. diff --git a/scripts/api-baseline.mjs b/scripts/api-baseline.mjs index d83b62ce..6a11e9b3 100644 --- a/scripts/api-baseline.mjs +++ b/scripts/api-baseline.mjs @@ -86,7 +86,7 @@ export async function createApiBaselineReport(options = {}) { const initializeRequestAttestationDisabled = initializeCapabilities.requestAttestation === false; if (!codexReadmeSemver) { - fail("README.md Compatibility table must define `codex.testedCliVersion` as X.Y.Z."); + fail("README.md Compatibility table must define `codexAppServer.testedCliVersion` as X.Y.Z."); } if (!codexRecordedSemver || codexRecordedSemver.version !== codexRecordedVersion) { fail("src/app-server/connection/compatibility.json must declare codexAppServer.testedCliVersion as X.Y.Z."); @@ -180,7 +180,7 @@ function readCompatibilityBaselines(readme) { const section = markdownSection(readme, "Compatibility"); const table = readMarkdownTableValues(section); return { - codexTestedCliVersion: table.get("codex.testedCliVersion") ?? null, + codexTestedCliVersion: table.get("codexAppServer.testedCliVersion") ?? null, obsidianApiTypesVersion: table.get("obsidian") ?? null, obsidianMinAppVersion: table.get("manifest.minAppVersion") ?? null, }; diff --git a/tests/scripts/development-scripts.test.ts b/tests/scripts/development-scripts.test.ts index ca98c915..022eb698 100644 --- a/tests/scripts/development-scripts.test.ts +++ b/tests/scripts/development-scripts.test.ts @@ -206,7 +206,7 @@ async function apiBaselineFixture(options: { recordedCodexVersion: string; readm "", "| Key | Version | Notes |", "| --- | --- | --- |", - `| \`codex.testedCliVersion\` | \`${options.readmeCodexVersion}\` | Tested CLI. |`, + `| \`codexAppServer.testedCliVersion\` | \`${options.readmeCodexVersion}\` | Tested CLI. |`, "| `manifest.minAppVersion` | `1.12.0` | Minimum app version. |", "| `obsidian` API types | `1.12.3` | Compile-time API package. |", ].join("\n"),