Skip to content

Commit 188e520

Browse files
committed
Start updating documentation
1 parent 0482c1d commit 188e520

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ ENV/
9292

9393
# Files containing secrets
9494
vuforia_secrets.env
95+
vuforia_secrets_ci.env
96+
vuforia_secrets_ci_master.env
9597

9698
# mypy
9799
.mypy_cache/

CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,17 +91,16 @@ Set either `SKIP_MOCK` or `SKIP_REAL` to `1` to skip tests against the mock, or
9191
Tests are run on Travis CI.
9292
The configuration for this is in `.travis.yml`.
9393

94-
Travis CI is set up with environment variables for connecting to Vuforia.
95-
These variables include those from `vuforia_secrets.env`.
94+
Travis CI is set up with secrets for connecting to Vuforia.
95+
These variables include those from `vuforia_secrets.env.example`.
96+
9697
They also include another set of variables especially for running the tests on the `master` branch.
9798
The tests are run daily against the `master` branch.
9899
This means that when the daily request quota is used, the `master` branch may show as failing on the `README`.
99100
Using the request quota on the `master` branch also leaves fewer requests for regular development.
100101
Therefore, `master` is given its own Vuforia database with separate limits.
101102

102-
These include the variables from `vuforia_secrets.env` prefixed with `MASTER_`.
103-
104-
All targets are deleted from the database beween each test.
103+
All targets are deleted from the database between each test.
105104
Therefore there may be conflicts if the test suite is run concurrently as Travis CI is configured to connect to one Vuforia database.
106105
As such, Travis CI is configured not to run multiple instances of the test suite concurrently.
107106

0 commit comments

Comments
 (0)