docs: add E2E test running guide - #1697
Open
magic-peach wants to merge 1 commit into
Open
magic-peach wants to merge 1 commit into
magic-peach wants to merge 1 commit into
Conversation
New contributors hit an opaque failure the first time they try to run E2E tests, since they need the CLI built first and a couple of pinned version env vars set that only show up in a code comment. Add a running-e2e.md under tests/docs per mukundansundar's suggestion on 1313, and link it from the development guide. Signed-off-by: Akanksha Trehun <akankshatrehun@gmail.com>
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
1 participant
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.
Description
docs/development/development.mdhad no guidance on running E2E tests: the--tags=e2erequirement, the need tomake buildfirst since tests exercise the built binary, or theDAPR_RUNTIME_PINNED_VERSION/DAPR_DASHBOARD_PINNED_VERSIONenvironment variables some standalone tests require. This PR addstests/docs/running-e2e.mdcovering those points, per mukundansundar's suggestion on the issue, and links it from the development guide.Issue reference
Please reference the issue this PR will close: #1313
Checklist
Please make sure you've completed the relevant tasks for this PR, out of the following list:
Notes: