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 more detail about SKIP_EMAIL_VERIFICATION_IN_DEV to e2e tests README #373

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

Conversation

pshycodr
Copy link

Fixes #363

Add SKIP_EMAIL_VERIFICATION_IN_DEV=true to template/app/.env.server.example file.

  • Add a new section to the file to skip email verification in development mode.
  • Add SKIP_EMAIL_VERIFICATION_IN_DEV=true to the new section.

Fixes wasp-lang#363

Add `SKIP_EMAIL_VERIFICATION_IN_DEV=true` to `template/app/.env.server.example` file.

* Add a new section to the file to skip email verification in development mode.
* Add `SKIP_EMAIL_VERIFICATION_IN_DEV=true` to the new section.
@vincanger
Copy link
Collaborator

Hey @pshycodr we actually would like to allow the user to decide for themselves if they want to skip email verification in development. Is there a reason you think it should be in there by default (if that reason is e2e tests, then you'll see we instruct the user to add it before running them in the e2e-tests README file).

@pshycodr
Copy link
Author

@vincanger
The reason for having the SKIP_EMAIL_VERIFICATION_IN_DEV environment variable set to true by default in the e2e tests is to ensure that the tests run smoothly without manual intervention.

@vincanger
Copy link
Collaborator

@vincanger The reason for having the SKIP_EMAIL_VERIFICATION_IN_DEV environment variable set to true by default in the e2e tests is to ensure that the tests run smoothly without manual intervention.

but we have an explicit mention of it in the e2e-tests/README.md:

Open another terminal and start the Wasp app with the environment variable set to skip email verification in development mode:

cd app && SKIP_EMAIL_VERIFICATION_IN_DEV=true wasp start

If we add this to the app by default, then users may not understand that the auth method sends an email verification link by default. They also won't be able to test their customize verification email they'd like to send. I think it's best we leave it as is.

@pshycodr
Copy link
Author

Hey @vincanger,
Thanks for the clarification. You're right, setting the variable by default might lead users to overlook email verification behavior during development.
I will update the PR to :

  • Remove the default SKIP_EMAIL_VERIFICATION_IN_DEV=true from .env.server.example.
  • Add clearer, explicit instructions in the e2e-tests/README.md on how to set this variable before running e2e tests.
    Let me know if you have any additional suggestions. And Thanks again for the feedback

Update README with SKIP_EMAIL_VERIFICATION_IN_DEV instructions and remove default from .env
Added more detailed explanations about the SKIP_EMAIL_VERIFICATION_IN_DEV variable in e2e-tests/README.md, including its significance, usage in CI pipelines, and troubleshooting tips. Let me know if any additional clarifications are needed!
@pshycodr
Copy link
Author

@vincanger
I updated the e2e-tests/README.md file, Added more detailed explanations about the SKIP_EMAIL_VERIFICATION_IN_DEV variable

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

Successfully merging this pull request may close these issues.

add more detail about SKIP_EMAIL_VERIFICATION_IN_DEV to e2e tests README
2 participants