Skip to content

Commit acb932b

Browse files
committed
docs(releases): align stable docs with 1.2.2
1 parent b9c9273 commit acb932b

4 files changed

Lines changed: 50 additions & 11 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -308,9 +308,9 @@ codex auth doctor --json
308308

309309
## Release Notes
310310

311-
- Current stable: [docs/releases/v1.1.10.md](docs/releases/v1.1.10.md)
312-
- Previous stable: [docs/releases/v0.1.9.md](docs/releases/v0.1.9.md)
313-
- Earlier stable: [docs/releases/v0.1.8.md](docs/releases/v0.1.8.md)
311+
- Current stable: [docs/releases/v1.2.2.md](docs/releases/v1.2.2.md)
312+
- Previous stable: [docs/releases/v1.2.1.md](docs/releases/v1.2.1.md)
313+
- Earlier stable: [docs/releases/v1.2.0.md](docs/releases/v1.2.0.md)
314314
- Archived prerelease: [docs/releases/v0.1.0-beta.0.md](docs/releases/v0.1.0-beta.0.md)
315315

316316
## License

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Public documentation for `codex-multi-auth`.
2323
| [configuration.md](configuration.md) | Stable defaults, precedence, and environment overrides |
2424
| [architecture.md](architecture.md) | Public system overview of the wrapper, storage, and optional plugin runtime |
2525
| [privacy.md](privacy.md) | Data handling and local storage behavior |
26-
| [releases/v1.1.10.md](releases/v1.1.10.md) | Stable release notes |
27-
| [releases/v0.1.9.md](releases/v0.1.9.md) | Previous stable release notes |
28-
| [releases/v0.1.8.md](releases/v0.1.8.md) | Earlier stable release notes |
26+
| [releases/v1.2.2.md](releases/v1.2.2.md) | Stable release notes |
27+
| [releases/v1.2.1.md](releases/v1.2.1.md) | Previous stable release notes |
28+
| [releases/v1.2.0.md](releases/v1.2.0.md) | Earlier stable release notes |
2929
| [releases/v0.1.7.md](releases/v0.1.7.md) | Archived stable release notes |
3030
| [releases/v0.1.6.md](releases/v0.1.6.md) | Archived stable release notes |
3131
| [releases/v0.1.5.md](releases/v0.1.5.md) | Archived stable release notes |
@@ -51,7 +51,7 @@ Public documentation for `codex-multi-auth`.
5151
| [reference/storage-paths.md](reference/storage-paths.md) | Canonical and compatibility storage paths |
5252
| [reference/public-api.md](reference/public-api.md) | Public API stability and semver contract |
5353
| [reference/error-contracts.md](reference/error-contracts.md) | CLI, JSON, and helper error semantics |
54-
| [releases/v1.1.10.md](releases/v1.1.10.md) | Current stable release notes |
54+
| [releases/v1.2.2.md](releases/v1.2.2.md) | Current stable release notes |
5555
| [releases/v0.1.0-beta.0.md](releases/v0.1.0-beta.0.md) | Archived prerelease reference |
5656
| [Daily Use release notes](#daily-use) | Stable, previous, and archived release notes |
5757
| [releases/legacy-pre-0.1-history.md](releases/legacy-pre-0.1-history.md) | Archived pre-0.1 changelog history |

docs/releases/v1.2.2.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Release v1.2.2
2+
3+
Release line: `stable`
4+
5+
This document anchors the current stable release reference used by the docs portal.
6+
7+
## Scope
8+
9+
- Current package version in `package.json` is `1.2.2`.
10+
- Canonical command family remains `codex auth ...`.
11+
- Canonical package name remains `codex-multi-auth`.
12+
- Keeps the docs portal and root README aligned with the currently published package version.
13+
14+
## Related
15+
16+
- [../getting-started.md](../getting-started.md)
17+
- [../upgrade.md](../upgrade.md)
18+
- [../reference/commands.md](../reference/commands.md)
19+
- [../reference/public-api.md](../reference/public-api.md)

test/documentation.test.ts

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@ import { UI_COPY } from "../lib/ui/copy.js";
1414

1515
const projectRoot = resolve(process.cwd());
1616

17+
function readPackageVersion(): string {
18+
const parsed = JSON.parse(readFileSync(join(projectRoot, "package.json"), "utf-8")) as {
19+
version?: unknown;
20+
};
21+
if (typeof parsed.version !== "string" || parsed.version.trim().length === 0) {
22+
throw new Error("package.json must define a non-empty version string");
23+
}
24+
return parsed.version.trim();
25+
}
26+
27+
const packageVersion = readPackageVersion();
28+
const currentStableReleaseDoc = `docs/releases/v${packageVersion}.md`;
29+
1730
const userDocs = [
1831
"docs/index.md",
1932
"docs/README.md",
@@ -30,9 +43,9 @@ const userDocs = [
3043
"docs/reference/error-contracts.md",
3144
"docs/reference/settings.md",
3245
"docs/reference/storage-paths.md",
33-
"docs/releases/v1.1.10.md",
34-
"docs/releases/v0.1.9.md",
35-
"docs/releases/v0.1.8.md",
46+
currentStableReleaseDoc,
47+
"docs/releases/v1.2.1.md",
48+
"docs/releases/v1.2.0.md",
3649
"docs/releases/v0.1.7.md",
3750
"docs/releases/v0.1.6.md",
3851
"docs/releases/v0.1.5.md",
@@ -122,10 +135,14 @@ describe("Documentation Integrity", () => {
122135
}
123136
});
124137

125-
it("docs portal links to stable, beta, and archived release history", () => {
138+
it("docs portal and root README link to stable, beta, and archived release history", () => {
126139
const portal = read("docs/README.md");
140+
const readme = read("README.md");
127141
expect(portal).toContain("reference/public-api.md");
128142
expect(portal).toContain("reference/error-contracts.md");
143+
expect(portal).toContain(`releases/v${packageVersion}.md`);
144+
expect(portal).toContain("releases/v1.2.1.md");
145+
expect(portal).toContain("releases/v1.2.0.md");
129146
expect(portal).toContain("releases/v0.1.7.md");
130147
expect(portal).toContain("releases/v0.1.6.md");
131148
expect(portal).toContain("releases/v0.1.5.md");
@@ -134,6 +151,9 @@ describe("Documentation Integrity", () => {
134151
expect(portal).toContain(
135152
"| [Daily Use release notes](#daily-use) | Stable, previous, and archived release notes |",
136153
);
154+
expect(readme).toContain(currentStableReleaseDoc);
155+
expect(readme).toContain("docs/releases/v1.2.1.md");
156+
expect(readme).toContain("docs/releases/v1.2.0.md");
137157

138158
const beta = read("docs/releases/v0.1.0-beta.0.md");
139159
expect(beta).toContain("Archived");

0 commit comments

Comments
 (0)