-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add configuration options to README #8
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed, the additional config variable was created due to a misunderstanding on how to run tests without starting LS in the same container.
I think the configuration options in the readme make sense, though!
Co-authored-by: Daniel Fangl <[email protected]>
|
||
There's a few env vars that can be used with this project: | ||
|
||
* `TEST_TARGET`: Set to `AWS_CLOUD` to use an externally-deployed instance when running tests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: In the future this shouldn't be part of the library. For now it's ok to include it in the README as it's still included 👍
* `SNAPSHOT_LEGACY_REPORT`: By default set to `0`. Can be set to `1`. | ||
* `SNAPSHOT_UDPATE`: By default set to `0`. Can be set to `1`. | ||
* `SNAPSHOT_RAW`: By default set to `0`. Can be set to `1`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: extend with what effect enabling these variables will have
Description
This is needed in case of running the LS tests against a non-local version of LS: i.e. an LS instance run on the host, or an instance of LS running in a K8s cluster locally/remotely.