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.

Closes #8856
@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 Oct 13, 2020
@SimenB
SimenB approved these changes Oct 13, 2020
Copy link
Collaborator

@SimenB SimenB left a comment

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

@stdavis
Copy link
Contributor Author

@stdavis 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
Collaborator

@jeysal 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 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
Collaborator

@SimenB 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 facebook:master Oct 14, 2020
16 of 22 checks passed
16 of 22 checks passed
cleanup-runs
Details
Running TypeScript compiler & ESLint
Details
Node v10.x on ubuntu-latest
Details
Node v10.x on macOS-latest
Details
Node v10.x on windows-latest
Details
Node v12.x on ubuntu-latest
Details
Node v12.x on macOS-latest
Details
Node v12.x on windows-latest
Details
Node v13.x on ubuntu-latest
Details
Node v13.x on macOS-latest
Details
Node v13.x on windows-latest
Details
Node v14.x on ubuntu-latest
Details
Node v14.x on macOS-latest
Details
Node v14.x on windows-latest
Details
ci/circleci: test-jest-circus CircleCI is running your tests
Details
ci/circleci: test-node-10 CircleCI is running your tests
Details
ci/circleci: test-node-12 CircleCI is running your tests
Details
ci/circleci: test-node-13 CircleCI is running your tests
Details
ci/circleci: test-node-14 CircleCI is running your tests
Details
facebook.jest in progress
Details
Facebook CLA Check Contributor License Agreement is valid!
Details
ci/circleci: test-or-deploy-website Your tests passed on CircleCI!
Details
@stdavis stdavis deleted the stdavis:env-var-docs branch Oct 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

4 participants
You can’t perform that action at this time.