Add scripts and targets for manpages and yamldocs #154
Conversation
Makefile
Outdated
| @@ -3,20 +3,22 @@ | |||
| # | |||
| all: binary | |||
|
|
|||
| PKGS := $(shell go list ./... | grep -vE '/vendor/|github.com/docker/cli/man|github.com/docker/cli/docs/yaml$$') | |||
There was a problem hiding this comment.
This is a problem. It causes a delay on every run of make even if we don't use this list.
I think this needs to be inside the scripts that use it (like it was previously).
This is unrelated to the docs generation scripts, right ? So at the very least could be discussed in a separate PR?
There was a problem hiding this comment.
I don't think we need to exclude man/ or docs/ from unit testing anymore , now that we have all the dependencies installed in vendor/.
There was a problem hiding this comment.
@dnephin sure, I will simply duplicate it in this Makefile, but I do want to remove grep -v vendor in unit-test-with-coverage, and replace it with $@.
docs/yaml/generate.sh
Outdated
| @@ -0,0 +1,5 @@ | |||
| #!/bin/sh | |||
There was a problem hiding this comment.
Could this be moved to scripts/docs/generate-yaml.sh to be consistent with our other scripts?
| @@ -7,6 +7,16 @@ set -eu | |||
|
|
|||
| mkdir -p ./man/man1 | |||
|
|
|||
| MD2MAN_REPO=github.com/cpuguy83/go-md2man | |||
There was a problem hiding this comment.
And this could be scripts/docs/generate-man.sh to be consistent with our other scripts.
tiborvass
force-pushed
the
add-man-docs-scripts
branch
from
77dbe60
to
1cd9c34
Compare
Codecov Report
@@ Coverage Diff @@
## master #154 +/- ##
=======================================
Coverage 44.96% 44.96%
=======================================
Files 169 169
Lines 11381 11381
=======================================
Hits 5117 5117
Misses 5971 5971
Partials 293 293 |
Makefile
Outdated
|
|
||
| # run go test | ||
| # the "-tags daemon" part is temporary | ||
| .PHONY: test | ||
| test: | ||
| ./scripts/test/unit $(shell go list ./... | grep -v /vendor/) | ||
| ./scripts/test/unit $(shell go list ./... | grep -vE '/vendor/|github.com/docker/cli/man|github.com/docker/cli/docs/yaml$$') |
There was a problem hiding this comment.
This no longer needs to ignore docs/ or man/
Signed-off-by: Tibor Vass <tibor@docker.com>
tiborvass
force-pushed
the
add-man-docs-scripts
branch
from
1cd9c34
to
ff615db
Compare
Signed-off-by: Tibor Vass tibor@docker.com