Skip to content

Commit 719f105

Browse files
Clarify environment variable requirements in README
Updated environment variable section for clarity and removed redundancy.
1 parent d973460 commit 719f105

1 file changed

Lines changed: 12 additions & 15 deletions

File tree

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,19 @@ npx playwright install
3737
This library does not pin a Node.js or Playwright version. Use versions appropriate for your project.
3838
Any recent Playwright Test 1.x release should work; align with what you already use.
3939

40-
### Environment variables
41-
Set the following (locally via .env, or in CI via your provider's secrets/variables):
4240

43-
- `CANVAS_HOST`
44-
- `OAUTH_TOKEN`
45-
- `DEPLOYMENT_TEST_PATH`
4641

47-
`CANVAS_HOST` should include protocol, domain and port (no trailing slash).
42+
43+
44+
## Write The Tests
45+
46+
The following must be set (locally via .env, or in CI via your provider's secrets/variables):
47+
* `CANVAS_HOST` - trailing slash is optional
48+
* `OAUTH_TOKEN`
49+
* `DEPLOYMENT_TEST_PATH` - leading slash is optional (Previously named `URL` which was changed as it was found to be confusing.)
50+
Use the utilities from this repository when writing your deployment tests.
51+
52+
If any are missing, `assertVariables.js` will fail fast to help you diagnose configuration.
4853

4954
Example:
5055

@@ -54,15 +59,7 @@ OAUTH_TOKEN=12345~QWERTYUIOPASDFGHJKLZXCVBNM
5459
DEPLOYMENT_TEST_PATH=/accounts/1/external_tools/789
5560
```
5661

57-
If any are missing, `assertVariables.js` will fail fast to help you diagnose configuration.
58-
59-
## Write The Tests
60-
61-
The following must be set (locally or in CI):
62-
* `CANVAS_HOST` - trailing slash is optional
63-
* `OAUTH_TOKEN`
64-
* `DEPLOYMENT_TEST_PATH` - leading slash is optional (Previously named `URL` which was changed as it was found to be confusing.)
65-
Use the utilities from this repository when writing your deployment tests. Here's a simple example which asserts that some specific text, `XXXXXXXXXXXXXXX`, appears on a page. The test(s) can be as simple or as complex as seems appropriate.
62+
Here's a simple example which asserts that some specific text, `XXXXXXXXXXXXXXX`, appears on a page. The test(s) can be as simple or as complex as seems appropriate.
6663

6764
```js
6865
import { test, expect } from '@playwright/test'

0 commit comments

Comments
 (0)