Skip to content

docs(lstk hotfix): update CLI reference to v0.19.0 - #830

Open
gtsiolis wants to merge 2 commits into
mainfrom
claude/intelligent-cray-shk3a9
Open

docs(lstk hotfix): update CLI reference to v0.19.0#830
gtsiolis wants to merge 2 commits into
mainfrom
claude/intelligent-cray-shk3a9

Conversation

@gtsiolis

@gtsiolis gtsiolis commented Jul 28, 2026

Copy link
Copy Markdown
Member

Brings the lstk CLI reference up to date with the v0.19.0 release.

Related issue: DOC-379

Files in scope (no shared lstk components exist yet, so each page carries its own reference content):

  • src/content/docs/aws/developer-tools/running-localstack/lstk.mdx
  • src/content/docs/azure/developer-tools/lstk.mdx

The AWS page previously reflected v0.18.0 (#808); the Azure page (#801) had drifted several releases behind and was skipped by the v0.18.0 hotfix. This PR covers the full v0.18.0..v0.19.0 range for AWS and catches up the entire backlog for Azure.

AWS page — v0.18.0..v0.19.0

  • --timeout flag (lstk start / bare lstk): added to the start options table, the Global options table, and the startup-deadline paragraph. Noted that an explicit --timeout wins over LSTK_STARTUP_TIMEOUT, --timeout 0 falls back to the per-mode default, and that restart and the snapshot auto-start path do not expose it. (This was intentionally deferred in docs(lstk hotfix): update CLI reference to v0.18.0 #808 because it landed after the v0.18.0 tag.)
  • -s/--services on snapshot save (and the save alias): comma-separated list limiting a save to a subset of services, applied uniformly to local, pod:, and s3:// destinations. Added to the save options table with an example.
  • --dry-run on snapshot load (and the load alias): previews the per-service resource additions/modifications a load would produce, without changing state. Documented that it is pod:-only and requires a running emulator (no auto-start).
  • License stale-token recovery: updated the offline section and the "License validation failed" troubleshooting entry — a definitive rejection (HTTP 400/401/403) now drops the cached license and, interactively, offers a re-login and retries once; non-interactively it points at lstk logout && lstk login. A manual lstk logout is no longer required.
  • Timeless wording: lstk terraform targets the AWS emulator (was "currently targets … only"), plus two smaller fixes in the Structured output section.

Azure page — full backlog catch-up

The Azure reference had fallen behind by the v0.16v0.19 feature set (last meaningfully updated at #801, and it skipped the v0.18.0 hotfix). It was missing: the --type flag and its section, the startup-deadline paragraph + --timeout, --tail/-n on logs, the entire Structured output / Exit codes sections and the richer --json descriptions, the LSTK_STARTUP_TIMEOUT and LSTK_MERGE_STRATEGY env vars, the multiple-installs warning, the Colima ~/.config socket path, and the proxy signal-forwarding note — plus all the v0.19.0 additions above.

The Azure page now carries the same reference content as the AWS page, differing in its frontmatter (no sidebar/tags), the /azure/ auth-token link, and the volume-mounts example (emulator-neutral rather than the AWS page's Snowflake init-hook example — per review feedback that the Snowflake reference was out of place on the Azure page). The three non-auth cross-links (Docker Compose install, corporate-proxy FAQ, Get Help) still point at the AWS docs, as they did before.

Review

Advisable.

  • The license-recovery wording is user-facing messaging worth a glance to confirm it reads the way the team wants.
  • The Azure resync is large because it absorbs several releases of drift in one pass, making the two pages near-identical. If the team would rather land the shared-component refactor first (Reusable lstk components #817) and keep the Azure page thinner, the Azure half can be trimmed — flagging for a decision.

Cc @localstack/devx for visibility and any corrections.

Co-Authored-By: Claude <noreply@anthropic.com>

Copy link
Copy Markdown
Member Author

The failing Validate Refs check (Restrict Docs PR merges) is a structural block, not something in this diff. It inspects only branch names: it passes when the base is aws-docs-*/snowflake-docs-*, or when a branch of that shape merges into main. This PR is claude/intelligent-cray-shk3a9main, so it's rejected regardless of contents.

This is the same shape as the previous lstk hotfix (#808, claude/zealous-davinci-n9hwn9main), which hit the same check and was still merged. I can't resolve it from here — the branch name is fixed for this change and renaming isn't an option — so it needs a maintainer to merge past it as before, or an exemption for the claude/* hotfix-docs branches in the policy.

The content checks are unaffected; the two files are the AWS and Azure lstk reference pages.


Generated by Claude Code

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

@gtsiolis this is missing a logged docs ticket. Please log a docs ticket for this and reference it in this PR before we move further.

@gtsiolis gtsiolis self-assigned this Jul 28, 2026

Copy link
Copy Markdown
Member Author

Docs ticket logged and referenced in the description: PRO-369. Thanks @quetzalliwrites!


Generated by Claude Code

Comment thread src/content/docs/azure/developer-tools/lstk.mdx Outdated
…e page

Co-Authored-By: Claude <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 28, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3ccc038
Status: ✅  Deploy successful!
Preview URL: https://ad7556d4.localstack-docs.pages.dev
Branch Preview URL: https://claude-intelligent-cray-shk3.localstack-docs.pages.dev

View logs

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

@gtsiolis that is a Product ticket, that is not a DOCS (linear team) ticket. We've discussed this before, all docs PRs need to be linked/tracked to DOCS ticket. Please update the ticket to be on the Linear DOCS team. ty

Copy link
Copy Markdown
Member Author

Thanks for moving the issue, updated PR description. ✔️


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants