Add check for docs #138
Add check for docs #138
Conversation
Codecov Report
@@ Coverage Diff @@
## master #138 +/- ##
=======================================
Coverage 73.23% 73.23%
=======================================
Files 36 36
Lines 1300 1300
=======================================
Hits 952 952
Misses 300 300
Partials 48 48Continue to review full report at Codecov.
|
scripts/docs.sh
Outdated
| if [ "$count" = "0" ]; then | ||
| return 0 | ||
| else | ||
| return 1 |
There was a problem hiding this comment.
Can you make this echo useful information such as:
"Your markdown docs seem to be out of sync with the package docs. Please run make and consult CONTRIBUTING.MD"
.travis.yml
Outdated
| @@ -15,7 +15,8 @@ install: | |||
| - dep ensure | |||
|
|
|||
| script: | |||
| - make test | |||
| - make test | |||
| - make checkdocs | |||
There was a problem hiding this comment.
Make sure the checkdocs are first.
|
Also need to add |
|
@mwitkow have made changes also note the annoying realpath change that I have added ... this is due to Travis not having realpath installed ... by the looks of things realpath is a can of worms. |
|
Legit. You don't need real path though, there's a bash one liner that does that. |
|
Updated as per discussion to change to bash one liner 👍 merging |
This ports grpc-ecosystem#138 to the v2 branch.
This commit adds a check for any change to the documentation that has not been correctly committed. It does this by regenerating the docs in Travis and then seeing if there are any changes due for staging in git.
Have also added a CONTRIBUTING.md file so that it is easier for new contributors to understand the flow.