Skip to content

Commit

Permalink
doc(README): explain tokens for testing
Browse files Browse the repository at this point in the history
  • Loading branch information
line-o committed Nov 21, 2024
1 parent 161a562 commit e5b6497
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,23 @@ The resulting xar(s) are found in the root of the project.

## Testing

To run the local test suite you need an instance of eXist running on `localhost:8080` and `npm` to be available in your path.
Run tests with ```npm test```
To run the local test suite you need an
* instance of eXist running on `localhost:8080` and
* `npm` to be available in your path
* a GitHub personal access token with read access to public repositories
* a gitlab personal access token with read access to public repositories

In CI these access tokens are read from environment variables.
You can do the same with
```bash
export tuttle_token_tuttle_sample_data=<GITHUB_PAT>; \
export tuttle_token_gitlab_sample_data=<GITLAB_PAT>; \
path/to/startup.sh
```

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!

Run tests with ```npm test```

## Configuration

Expand Down

0 comments on commit e5b6497

Please sign in to comment.