Skip to content

Commit afe8b72

Browse files
Document LocalStack authentication requirements (#1295)
1 parent 841179f commit afe8b72

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ It captures practical rules that prevent avoidable CI and PR churn.
2020
- If a public API changes, update the relevant docs in the same PR.
2121
- If new types are made part of the public API, export them from the package's `index.ts` in the same PR.
2222
- If new learnings or misunderstandings are discovered, propose an `AGENTS.md` update in the same PR.
23+
- In docs Markdown, keep `<!--codeinclude-->` blocks tight with no blank lines between the markers and the include line, or the rendered snippet will contain blank lines between code lines.
2324
- Tests should verify observable behavior changes, not only internal/config state.
2425
- Example: for a security option, assert a real secure/insecure behavior difference.
2526
- Test-only helper files under `src` (for example `*-test-utils.ts`) must be explicitly excluded from package `tsconfig.build.json` so they are not emitted into `build` and accidentally published.
@@ -50,9 +51,9 @@ It captures practical rules that prevent avoidable CI and PR churn.
5051
- Never bypass signing (for example, do not use `--no-gpg-sign`).
5152
- If signing fails (for example, passphrase/key issues), stop and ask the user to resolve signing, then retry.
5253
8. Push branch. Ask for explicit user permission before any force push.
53-
9. Open PR against `main` using a human-readable title (no `feat(...)` / `fix(...)` prefixes).
54-
- When using `gh` to create/edit PR descriptions, prefer `--body-file <path>` over inline `--body`.
55-
- This avoids shell command substitution issues when the body contains backticks.
54+
9. Open PR against `main` using a human-readable title (no `feat(...)` / `fix(...)` prefixes, and no agent-identifying prefixes or suffixes).
55+
- Default to a ready-for-review PR. Only open or keep a PR in draft when the user explicitly asks for a draft.
56+
- When using `gh` to create/edit PR descriptions, prefer `--body-file <path>` over inline `--body`; this avoids shell command substitution issues when the body contains backticks.
5657
10. Add labels for both change type and semantic version impact.
5758
11. Ensure PR body includes:
5859
- summary of changes

docs/modules/localstack.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,27 @@ These examples use the following libraries:
1616

1717
Choose an image from the [container registry](https://hub.docker.com/r/localstack/localstack) and substitute `IMAGE`.
1818

19+
!!! note "Authentication requirements"
20+
Starting on March 23, 2026, LocalStack moved to authenticated image releases. Older pinned tags may continue to work without `LOCALSTACK_AUTH_TOKEN`, but newer releases require it.
21+
22+
Prefer pinning a specific image tag instead of using `latest`. If the image tag you use requires authentication, pass `LOCALSTACK_AUTH_TOKEN` when starting the container:
23+
24+
```typescript
25+
const token = process.env.LOCALSTACK_AUTH_TOKEN;
26+
27+
if (!token) {
28+
throw new Error("LOCALSTACK_AUTH_TOKEN must be set for authenticated LocalStack images");
29+
}
30+
31+
const container = await new LocalstackContainer("localstack/localstack:IMAGE")
32+
.withEnvironment({ LOCALSTACK_AUTH_TOKEN: token })
33+
.start();
34+
```
35+
36+
Refer to the [LocalStack announcement](https://blog.localstack.cloud/localstack-single-image-next-steps/) for the current rollout details.
37+
1938
### Create a S3 bucket
2039

2140
<!--codeinclude-->
2241
[](../../packages/modules/localstack/src/localstack-container.test.ts) inside_block:localstackCreateS3Bucket
2342
<!--/codeinclude-->
24-

0 commit comments

Comments
 (0)