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 environment variables docs page #10630

Merged
merged 6 commits into from
Oct 14, 2020
Merged

Add environment variables docs page #10630

merged 6 commits into from
Oct 14, 2020

Conversation

stdavis
Copy link
Contributor

@stdavis stdavis commented Oct 13, 2020

Closes #8856

Summary

Provide a central list of all environment variables set by Jest. I searched through the jest code and think that I found all of the variables that it sets. Please let me know if I missed any.

Test plan

I've previewed the changes locally on the website and they look good to me.

@stdavis stdavis changed the title docs: add environment variables page Add environment variables docs page Oct 13, 2020
@stdavis stdavis marked this pull request as ready for review October 13, 2020 17:57
Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful, thanks! I'll play with this tomorrow so it's available across versions but this is great! 👍

@stdavis
Copy link
Contributor Author

stdavis commented Oct 13, 2020

I'd be happy to push it to other versions if you'd like. Should it be pushed to all of them?

@jeysal
Copy link
Contributor

jeysal commented Oct 13, 2020

Yep, both of those variables have been around for ages, so all of them. Don't forget to update both versioned_docs and versioned_sidebars since this is one of the rare cases where the latter also changed

@stdavis
Copy link
Contributor Author

stdavis commented Oct 13, 2020

Let me know if I missed something. I'm so happy to help contribute (in a tiny way) to a super-awesome tool that I use every day.

@SimenB
Copy link
Member

SimenB commented Oct 14, 2020

Docusaurus picks up the version of the docs from a previous release, so we just need a "master" version in docs/ and in the oldest "versioned version" of the docs in addition to the sidebar

@SimenB SimenB merged commit d077f2e into jestjs:master Oct 14, 2020
@stdavis stdavis deleted the env-var-docs branch October 14, 2020 13:34
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Please document what ENV variables are set by Jest
4 participants