docs: update README and docs for v0.18.0#407
Conversation
Co-Authored-By: Claude <noreply@anthropic.com>
|
Heads-up: Probably not as relevant after we merge #406, may have to revisit or close. |
|
Good catch — checked #406's diff: it removes the README's Features list, Environment Variables table, "Passing environment variables to the container" section, and Usage examples entirely (in favor of linking out to docs.localstack.cloud), which is exactly the content three of my four changes here touch. The Plan: once #406 merges, I'll rebase this PR and drop the now-nonexistent README hunks, keeping only the CLAUDE.md fixes. Let me know if you'd rather I just close this one and let a future docs-sync pass pick up the CLAUDE.md fixes fresh instead. Generated by Claude Code |
Summary
Audited README.md, CLAUDE.md, every
internal/*/CLAUDE.md, and every file underdocs/against current source for the v0.18.0 release, covering the full range since the last docs update (docs: update README and docs for v0.17.1, #389).Most of the delta since then was already documented in-PR (
--typeflag,LSTK_MERGE_STRATEGY, SIGINT/SIGTERM forwarding, the bash-completion fix, the emulator-selection fix). Cross-checkinglstk --helpoutput, theMakefile, and source against the docs turned up a few real gaps:make buildno longer cleans first (changed by Fix test-integration running against a stale binary #395, which switched the target to a plaingo buildrelying on Go's build cache) — the "Build and Test Commands" comment still claimed otherwise. Also added theinternal/procpackage (added by feat: forward SIGINT/SIGTERM to wrapped tools for graceful shutdown #391) to the Architecture package list; it was referenced elsewhere in the file but missing from the list itself.-n/--tailflag added tolstk logs(Add-n/--tailsupport tolstk logs#359) in the Features list and a Usage example; added theLSTK_MERGE_STRATEGYenv var to the Environment Variables table (Add LSTK_MERGE_STRATEGY env var for snapshot load default #400); noted thatlstk start --timeoutoverridesLSTK_STARTUP_TIMEOUTfor a single run; extended the "Passing environment variables to the container" section to describe the varsfilterHostEnvnow drops (and warns about) instead of forwarding —LOCALSTACK_AUTH_TOKEN, and any host var whose stripped name would clobber a critical container var likePATH/HOME(fix: don't let LOCALSTACK_PATH clobber emulator PATH #378).filterHostEnv's drop rules (silent forLOCALSTACK_AUTH_TOKEN, warned for newline-containing values and critical-var clobbers), since this logic had no reference doc anywhere.Needing a human decision
None — no public-messaging wording changed; all additions describe existing, already-shipped behavior.
Test plan
make buildsucceedslstk --helpandlstk logs --helpoutput against the new README contentfilterHostEnvdrop rules againstinternal/container/start.goMakefile'sbuild/test-integrationtargets against the corrected CLAUDE.md wordingCo-Authored-By: Claude <noreply@anthropic.com>