docs(architecture): audit CLI and distribution group against implementation - #4801
Open
ggbdpq wants to merge 1 commit into
Open
docs(architecture): audit CLI and distribution group against implementation#4801ggbdpq wants to merge 1 commit into
ggbdpq wants to merge 1 commit into
Conversation
ggbdpq
force-pushed
the
docs/audit-cli-dist-a8
branch
from
September 4, 2026 22:48
7645ad9 to
0c29bd8
Compare
…tation Audit the five CLI and distribution documents from the apache#3522 documentation audit against the current implementation (22715e8). No drift found in any of the five. Highlights of what was verified: - cli-distribution.md: every named enforcement artifact exists (scripts/product-release-identity.mjs with the RELEASE.json identity fields, .github/workflows/release.yml, DISCLAIMER-WIP); the archive layout names are packaging-time outputs as the document describes. - cli-npm-release.md + zh-CN: the workflow filenames resolve (npm-publication.yml, desktop-nightly.yml, release-cli-stage.yml, release-cli-finalize.yml), and the pair stays in lockstep on the Trusted Publisher / OIDC / 2FA / Finalize flow. - windows-support.md: the installer name matches scripts/desktop-release-targets.mjs (`Maka-${version}-win-x64.exe`); the AppContainer filesystem-worker claim matches the tree; tracking issue apache#2142 is open as stated. - windows-test-inventory.md: `npm run windows:inventory` (the repo's own check) passes with "Windows test skip inventory is current (76 declarations)". The four hand-maintained documents gained the standard frontmatter block with `last_verified` (the npm-release pair keeps `translation_status: synced`). windows-test-inventory.md stays frontmatter-free on purpose: it is generated by `scripts/windows-test-inventory.mjs --write`, and its `--check` compares the file byte-for-byte with regenerated output, so manual frontmatter on it fails CI. Refs apache#3522 Generated-by: GLM-5.3-Flash (ZCode)
ggbdpq
force-pushed
the
docs/audit-cli-dist-a8
branch
from
September 4, 2026 23:00
0c29bd8 to
76588b2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audits the CLI and distribution group (5 documents) from #3522 against the current implementation (22715e8). No drift found in any of the five; the four hand-maintained documents gain the standard frontmatter block with
last_verified, while the generated inventory document is left byte-identical to its base revision.docs/cli-distribution.md— enforcement artifacts exist:scripts/product-release-identity.mjs(with theRELEASE.jsonidentity fields such assourceCommit),.github/workflows/release.yml, rootDISCLAIMER-WIP. Thebin/maka/libexec/**names are archive-layout outputs, as the document itself scopes them.docs/cli-npm-release.md+.zh-CN.md— every referenced workflow resolves (npm-publication.yml,desktop-nightly.yml,release-cli-stage.yml,release-cli-finalize.yml), and the pair stays in lockstep on the Trusted Publisher / OIDC staging / 2FA / Finalize provenance flow.docs/windows-support.md— the installer name matchesscripts/desktop-release-targets.mjs(Maka-${version}-win-x64.exe); the AppContainer filesystem-worker claim matches the tree; tracking issue roadmap(windows): make Windows a supported platform #2142 is open as stated.docs/windows-test-inventory.md— verified with the repository's own check:npm run windows:inventorypasses ("Windows test skip inventory is current (76 declarations)"). The document itself stays untouched: it is generated byscripts/windows-test-inventory.mjs --write, and its--checkcompares the file byte-for-byte with regenerated output, so hand-added frontmatter on it fails CI (caught by the first CI run; the file is restored to its base revision here).Verification
ls/ grep on the named scripts and.github/workflows/scripts/product-release-identity.mjssourceCommitetc. presentscripts/desktop-release-targets.mjsMaka-${version}-win-x64.exeexactnpm run windows:inventorynode scripts/windows-test-inventory.mjs --checkon the branchnpm run format:check/npm run check:asf-headersNot re-verified (external to the repository): the winget package id
BurntSushi.ripgrep.MSVCin the windows-support install steps is an upstream registry reference.AI use
Prepared with ZCode (GLM-5.3-Flash): read all five documents, bulk-verified every path-like reference, ran the repository's own inventory check, and added the frontmatter to the hand-maintained documents. The commit carries the
Generated-bytrailer.Checklist
Refs #3522in the commit messagetranslation_status: synced)last_verifiedset to the audit date (2026-09-04)