Skip to content

Commit f7e4fd7

Browse files
committed
Travis CI example
1 parent a3e9c62 commit f7e4fd7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,22 @@ _gen-modules:
195195
)
196196
```
197197

198+
#### Travis CI integration
199+
With the above Makefile in place, you can easily add a Travis CI rule to ensure the terraform-docs
200+
output is always up-to-date and will fail otherwise (due to git changes):
201+
```yml
202+
---
203+
sudo: required
204+
services:
205+
- docker
206+
before_install: true
207+
install: true
208+
script:
209+
- make gen
210+
- git diff --quiet || { echo "Build Changes"; git diff; git status; false; }
211+
```
212+
213+
198214
## Example projects
199215

200216
Find below some example projects how this Docker image is used in CI to verify if the README.md has

0 commit comments

Comments
 (0)