Skip to content

Commit b0fc6ef

Browse files
committed
Add Travis + Running tests section
1 parent c90786d commit b0fc6ef

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,27 @@
22

33
Test is an [Ash](https://github.com/ash-shell/ash) module that offers easy unit testing, with simple CI integrations.
44

5-
## Getting Started
5+
## Running Tests
6+
7+
You can run tests by running the following command:
8+
9+
```sh
10+
ash test $module-to-test
11+
```
12+
13+
Where `$module-to-test` is either a module alias, or a module package.
14+
15+
## Hooking Up a Module to Travis
16+
17+
You can generate the `.travis.yml` file by running the following command while in your modules directory:
18+
19+
```
20+
ash test:travis
21+
```
22+
23+
If your tests are already written, there is no further configuration you need to do beyond enabling your repository on Travis.
24+
25+
## Writing Tests
626

727
### The `ash_config.yaml` File
828

0 commit comments

Comments
 (0)