-
Notifications
You must be signed in to change notification settings - Fork 120
Add a document describing our environment variable usage. #1300
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
base: main
Are you sure you want to change the base?
Conversation
Adds a document describing our environment variable usage for reference by developers working on Swift Testing. This document is not an API contract: the set of environment variables Swift Testing uses may change at any time.
|
||
# Environment variables in Swift Testing | ||
|
||
This document lists the environment variables that Swift Testing currently uses. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This document lists the environment variables that Swift Testing currently uses. | |
This document lists the environment variables that Swift Testing uses. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using "currently" begs the question of how relevant is the content when the reader is finding it and when the doc was published; I'd recommend dropping it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"uses at the time of this writing" perhaps
Co-authored-by: Joseph Heck <[email protected]>
Those environment variables marked with `*` are defined by components outside | ||
Swift Testing. In general, environment variables that Swift Testing defines have | ||
names prefixed with `SWT_`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For these, I wonder if using a footnote for each one containing a link to a relevant website which documents it would be useful? I tried clicking the asterisk thinking it might reveal more information and thought that might be helpful
I just landed #1287 and it added a new env var I imagine we could place it in a new section (with its own table) titled "Event stream" perhaps, and hoist |
Adds a document describing our environment variable usage for reference by developers working on Swift Testing.
This document is not an API contract: the set of environment variables Swift Testing uses may change at any time.
Checklist: