Appearance
Settings (environment variables)
An environment variable is a named setting you give the computer before running a command. It keeps private things, such as passwords, out of your recording and out of the command itself.
You only need these when a guide tells you to. Most people never set any.
How to set one
Windows (PowerShell): $env:NAME='value'Mac or Linux: export NAME='value'
The setting lasts until you close that window.
Replaying a recording
Use these when a replay needs something that BugTrail deliberately did not save.
BUGTRAIL_SECRETS: passwords and private text
Why: BugTrail never saves passwords. A recording only contains *** where you typed one, so replay needs you to supply it again.
What to put: the field and its value, in this shape:
text
{"#password":"my-password"}The part before the colon is the field (shown in the replay error, for example masked value needs a secret for #password). The part after is the value to type.
BUGTRAIL_FILES: files to upload
Why: recordings do not contain your files, only the fact that you uploaded one.
What to put: the field and the full path of each file:
text
{"#cv":["/full/path/to/cv.pdf"]}BUGTRAIL_CHROMIUM: use a specific browser
Why: replay normally finds a browser by itself. Set this only if it says it cannot find one.
What to put: the full path to a Chrome or Chromium program on your computer.
Generated test scripts
A generated test script asks for these when it runs, for the same reasons as above. The part in capitals after the last underscore is the name of the field.
| Setting | What it is for |
|---|---|
BUGTRAIL_SECRET_<FIELD> | The password or private text for that field. For a field #password the setting is BUGTRAIL_SECRET_PASSWORD. |
BUGTRAIL_UPLOAD_<FIELD> | The full path of the file to upload in that field. |
The script stops with a message naming the exact setting it needs, so you do not have to guess.
Filing Jira bugs
Only needed with --jira. Together they tell BugTrail which Jira to file the bug in and prove it is you. Full steps are in File Jira bugs automatically.
| Setting | What to put | Example |
|---|---|---|
JIRA_BASE_URL | The web address of your Jira | https://yourteam.atlassian.net |
JIRA_EMAIL | The email you use to sign in to Jira | you@example.com |
JIRA_API_TOKEN | A token you create in your Atlassian account. It works like a password for tools; never share it | (the token) |
JIRA_PROJECT_KEY | The short code at the start of your issue numbers, such as the SHOP in SHOP-12 | SHOP |
JIRA_ISSUE_TYPE | Optional. The kind of issue to create. Leave it out for Bug | Bug |