Rename RESTATE_API_KEY env var to RESTATE_AUTH_TOKEN#389
Open
Rename RESTATE_API_KEY env var to RESTATE_AUTH_TOKEN#389
Conversation
2 tasks
2 tasks
Contributor
Author
|
CI checks are failing for unrelated reason, addressed by #390 |
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.
Use RESTATE_AUTH_TOKEN everywhere for consistency, based on customer feedback.
Summary
RESTATE_API_KEYenvironment variable toRESTATE_AUTH_TOKENacross the five CDK Lambda examples (TypeScript, Go, Java, Kotlin, Python), the Next.js template, and the integration test runner.RESTATE_AUTH_TOKENfor the API key already; only these examples were the outlier. A customer flagged the inconsistency between docs pages and tooling, which surfaced when configuring deployments end-to-end.Files touched
typescript/integrations/deployment-lambda-cdk/{lib/lambda-ts-cdk-stack.ts,README.md}go/integrations/go-lambda-cdk/{cdk/go-lambda-cdk-stack.ts,README.md}java/integrations/java-gradle-lambda-cdk/{cdk/lambda-jvm-cdk-stack.ts,README.md}kotlin/integrations/kotlin-gradle-lambda-cdk/{cdk/lambda-jvm-cdk-stack.ts,README.md}python/integrations/deployment-lambda-cdk/{lib/lambda-python-stack.ts,README.md}typescript/templates/nextjs/app/actions.ts.tools/run_node_tests.shThis is a straight rename with no backward compatibility shim: callers must update their environment to use the new variable name.
Test plan
RESTATE_AUTH_TOKEN=key_test(the test runner was updated to set the new name)cdk synthof the TypeScript stack withRESTATE_AUTH_TOKENset produces a valid templateRESTATE_ENV_IDnorRESTATE_AUTH_TOKENare setrestatedev/docs-restateis merged so the CDK code block ondocs/cloud/connecting-servicesstays in sync