chore(docs): refresh AGENTS.md and native codebase audit#388
Merged
Conversation
Pure rename to align with the docs/research/ layout convention. Content rewrite follows in the next commit so git rename detection holds. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Marc Nuri <marc@marcnuri.com>
Re-verified findings against current HEAD. Updates since 2025-11-14: status/history/get-values shipped (PRs #345/#352/#353), NewCfg panic fixed, newRegistryClient extraction done. Still open: install/upgrade defer cancel() leak, three TODOs (helm.go, search.go, repotest.go), and rollback/pull commands (#101, #351). Restructured to match docs/research conventions: dated header with related issue/PR links, TL;DR, status-of-prior-findings table. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Marc Nuri <marc@marcnuri.com>
Fix factual errors and gaps that would mislead agents working in the repo: - Correct Go version (1.25.7, not 1.25.0+) - Replace inaccurate native/ tree: real Go logic lives in native/internal/helm/, not native/main.go (which is a CGO bridge only) - Replace ad-hoc file enumerations with a role-based table driven by the naming conventions, so it doesn't go stale on every new command - Document SPI-based native library loading (ServiceLoader + RemoteJarLoader fallback) and OS-activated Maven profiles - Document static-vs-instance API duality on Helm.java - Document CI Java-version split (8 on Linux, 11 on macOS/Windows) - Add missing Makefile targets (test-go, update-go-deps, license, release, build-native-wasi) - Fix the "Adding a New Helm Command" workflow to point at internal/helm/<verb>.go, not main.go - Mark lib/wasi/ and native/wasm/ as abandoned (issue #239) - Replace stale ANALYSIS.md pointer with link to refreshed audit - Add call-flow diagram so agents can hold the JNA → CGO → Go path in their head Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Marc Nuri <marc@marcnuri.com>
af04708 to
a470f2a
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
Refresh of the agent-facing docs in this repo.
native/tree — real Go logic lives ininternal/helm/, notmain.go), documents SPI-based native library loading and OS-activated Maven profiles, the static-vs-instance Java API duality, and the CI Java-version split (8 on Linux, 11 on macOS/Windows). Replaces ad-hoc file enumerations with role-based tables driven by naming conventions so the doc doesn't go stale on every new command. Markslib/wasi/andnative/wasm/as abandoned ([INITIATIVE] WebAssembly-based lib module #239).docs/research/native-codebase-audit.mdmoved fromANALYSIS.mdat the repo root and refreshed against currentHEAD. Previously-missing commandsstatus/history/get valuesare now noted as shipped (feat: add support for "helm get values" command #345/feat: add support for "helm status" command (#349) #352/feat: implement helm history command #353); theNewCfgpanic andValuesFilesfallback bug are confirmed fixed;newRegistryClientextraction landed. Still open: install/upgradedefer cancel()leak, three TODOs inhelm.go/search.go/repotest.go, and rollback/pull (feat: implement helm pull command #101, feat: implement helm rollback command #351). Coverage dropped to ~30% because the three new commands shipped without Go tests.The move is done as a pure rename commit (100% similarity), so
git log --follow docs/research/native-codebase-audit.mdtraces history through to the originalANALYSIS.md.Test plan
git log --follow docs/research/native-codebase-audit.mdreaches the original ANALYSIS.md history