Skip to content

Commit e5b6497

Browse files
committed
doc(README): explain tokens for testing
1 parent 161a562 commit e5b6497

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,23 @@ The resulting xar(s) are found in the root of the project.
3838

3939
## Testing
4040

41-
To run the local test suite you need an instance of eXist running on `localhost:8080` and `npm` to be available in your path.
42-
Run tests with ```npm test```
41+
To run the local test suite you need an
42+
* instance of eXist running on `localhost:8080` and
43+
* `npm` to be available in your path
44+
* a GitHub personal access token with read access to public repositories
45+
* a gitlab personal access token with read access to public repositories
46+
47+
In CI these access tokens are read from environment variables.
48+
You can do the same with
49+
```bash
50+
export tuttle_token_tuttle_sample_data=<GITHUB_PAT>; \
51+
export tuttle_token_gitlab_sample_data=<GITLAB_PAT>; \
52+
path/to/startup.sh
53+
```
54+
55+
Alternatively, you can modify `/db/apps/tuttle/data/tuttle.xml` _and_ `test/fixtures/alt-tuttle.xml` to include your tokens. But remember to never commit them!
56+
57+
Run tests with ```npm test```
4358

4459
## Configuration
4560

0 commit comments

Comments
 (0)