Skip to content
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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

RobertLucian
Copy link

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.

@RobertLucian RobertLucian added the enhancement New feature or request label Feb 24, 2025
@RobertLucian RobertLucian self-assigned this Feb 24, 2025
Copy link
Member

@dfangl dfangl left a 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!

@RobertLucian RobertLucian changed the title Skip specific snapshot paths when running tests against non-local versions of LS Add configuration options to README Feb 25, 2025
@RobertLucian RobertLucian requested a review from dfangl February 25, 2025 14:58

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.
Copy link
Member

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 👍

Comment on lines +20 to +22
* `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`.
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants