Skip to content

Commit a6b8408

Browse files
committed
Adds mention of integration tests to README file.
1 parent ce43cf9 commit a6b8408

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,23 @@ $filesystem = new Filesystem($adapter);
8989

9090
## Testing
9191

92+
The unit-tests can be run with the following command:
93+
9294
``` bash
9395
$ composer test
9496
```
9597

98+
To run integration tests, which use the Github API, a [Github API token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) might be needed (to stop the tests hitting the API Limit).
99+
An API key can be added by setting in the environment as `GITHUB_API_KEY` or by vreating an `.env` file in the integration tests directory and setting it there.
100+
See `tests/integration-tests/.env.example` for an example.
101+
102+
To run the integration test, run the following command (this will also run the unit-tests):
103+
104+
``` bash
105+
$ composer test-all
106+
```
107+
108+
96109
## Security
97110

98111
If you discover any security related issues, please email [email protected] instead of using the issue tracker.

0 commit comments

Comments
 (0)