docs: correct app-server compatibility key

This commit is contained in:
murashit 2026-07-18 08:59:33 +09:00
parent dfeeb0e4b2
commit 93d0021391
3 changed files with 8 additions and 8 deletions

View file

@ -60,11 +60,11 @@ Threads can be archived as Markdown notes with a configurable folder, filename t
## Compatibility ## Compatibility
| Key | Version | Policy | | Key | Version | Policy |
| ------------------------ | --------- | --------------------------------------------------------------------------------------------------- | | -------------------------------------- | --------- | --------------------------------------------------------------------------------------------------- |
| `manifest.minAppVersion` | `1.12.0` | Minimum Obsidian desktop version declared for plugin loading. | | `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. | | `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. | | `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. Codex Panel depends on the experimental `codex app-server` API.

View file

@ -86,7 +86,7 @@ export async function createApiBaselineReport(options = {}) {
const initializeRequestAttestationDisabled = initializeCapabilities.requestAttestation === false; const initializeRequestAttestationDisabled = initializeCapabilities.requestAttestation === false;
if (!codexReadmeSemver) { 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) { if (!codexRecordedSemver || codexRecordedSemver.version !== codexRecordedVersion) {
fail("src/app-server/connection/compatibility.json must declare codexAppServer.testedCliVersion as X.Y.Z."); 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 section = markdownSection(readme, "Compatibility");
const table = readMarkdownTableValues(section); const table = readMarkdownTableValues(section);
return { return {
codexTestedCliVersion: table.get("codex.testedCliVersion") ?? null, codexTestedCliVersion: table.get("codexAppServer.testedCliVersion") ?? null,
obsidianApiTypesVersion: table.get("obsidian") ?? null, obsidianApiTypesVersion: table.get("obsidian") ?? null,
obsidianMinAppVersion: table.get("manifest.minAppVersion") ?? null, obsidianMinAppVersion: table.get("manifest.minAppVersion") ?? null,
}; };

View file

@ -206,7 +206,7 @@ async function apiBaselineFixture(options: { recordedCodexVersion: string; readm
"", "",
"| Key | Version | Notes |", "| Key | Version | Notes |",
"| --- | --- | --- |", "| --- | --- | --- |",
`| \`codex.testedCliVersion\` | \`${options.readmeCodexVersion}\` | Tested CLI. |`, `| \`codexAppServer.testedCliVersion\` | \`${options.readmeCodexVersion}\` | Tested CLI. |`,
"| `manifest.minAppVersion` | `1.12.0` | Minimum app version. |", "| `manifest.minAppVersion` | `1.12.0` | Minimum app version. |",
"| `obsidian` API types | `1.12.3` | Compile-time API package. |", "| `obsidian` API types | `1.12.3` | Compile-time API package. |",
].join("\n"), ].join("\n"),