From afd0ecbbf2fbda2f9459046228ccc9e8d2693258 Mon Sep 17 00:00:00 2001 From: Ajitem Sahasrabuddhe Date: Mon, 9 Sep 2019 08:19:06 +0530 Subject: [PATCH 1/6] Add support for Go 1.13 Drop support for Go 1.11 Use md2man v2 to avoid dependency issues when building with Go Modules Enabled Update TravisCI build environment images (trusty was deprecated) Add optional Windows build --- .travis.yml | 16 +++++++++------- docs.go | 2 +- go.mod | 2 +- go.sum | 12 ++++++++---- 4 files changed, 19 insertions(+), 13 deletions(-) diff --git a/.travis.yml b/.travis.yml index ce2a96b..7eca52c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,15 +1,19 @@ language: go sudo: false -dist: trusty -osx_image: xcode8.3 +dist: bionic +osx_image: xcode10 go: - - 1.10.x - 1.11.x - 1.12.x + - 1.13.x os: - linux - osx + - windows + +env: + GO111MODULE=on cache: directories: @@ -20,14 +24,12 @@ before_script: - go get github.com/shurcooL/httpfs/union || true - go get github.com/urfave/gfmrun/... || true - go get golang.org/x/tools/cmd/goimports - - if [ ! -f node_modules/.bin/markdown-toc ] ; then - npm install markdown-toc ; - fi + - npm install markdown-toc script: - go run build.go generate - go run build.go vet - - go run build.go test + - go run build.go testm - go run build.go gfmrun - go run build.go toc diff --git a/docs.go b/docs.go index 0beadf2..ed79b44 100644 --- a/docs.go +++ b/docs.go @@ -8,7 +8,7 @@ import ( "strings" "text/template" - "github.com/cpuguy83/go-md2man/md2man" + "github.com/cpuguy83/go-md2man/v2/md2man" ) // ToMarkdown creates a markdown string for the `*App` diff --git a/go.mod b/go.mod index 1b94cfe..38803d6 100644 --- a/go.mod +++ b/go.mod @@ -4,6 +4,6 @@ go 1.10 require ( github.com/BurntSushi/toml v0.3.1 - github.com/cpuguy83/go-md2man v1.0.10 + github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d gopkg.in/yaml.v2 v2.2.2 ) diff --git a/go.sum b/go.sum index a8e436a..ef121ff 100644 --- a/go.sum +++ b/go.sum @@ -1,9 +1,13 @@ github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= -github.com/cpuguy83/go-md2man v1.0.10 h1:BSKMNlYxDvnunlTymqtgONjNnaRV1sTpcovwwjF22jk= -github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE= -github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo= -github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g= +github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY= +github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q= +github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo= +github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= From edbf66c25cf83541faee77d0064fdb5ac35a51b1 Mon Sep 17 00:00:00 2001 From: Ajitem Sahasrabuddhe Date: Mon, 9 Sep 2019 08:23:04 +0530 Subject: [PATCH 2/6] Update gfmrun import command to suite Go Modules pattern Fix test command typo in travis script --- .travis.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 7eca52c..86394e5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -20,16 +20,14 @@ cache: - node_modules before_script: - - go get github.com/shurcooL/vfsgen || true - - go get github.com/shurcooL/httpfs/union || true - - go get github.com/urfave/gfmrun/... || true + - go get github.com/urfave/gfmrun/cmd/gfmrun - go get golang.org/x/tools/cmd/goimports - npm install markdown-toc script: - go run build.go generate - go run build.go vet - - go run build.go testm + - go run build.go test - go run build.go gfmrun - go run build.go toc From 39bd6176649871817d1966b6b91f042be4b62fe9 Mon Sep 17 00:00:00 2001 From: Ajitem Sahasrabuddhe Date: Mon, 9 Sep 2019 08:37:16 +0530 Subject: [PATCH 3/6] Cleanup after before_script to avoid git diff errors remove windows build --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 86394e5..e978823 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,7 +10,6 @@ go: os: - linux - osx - - windows env: GO111MODULE=on @@ -23,6 +22,7 @@ before_script: - go get github.com/urfave/gfmrun/cmd/gfmrun - go get golang.org/x/tools/cmd/goimports - npm install markdown-toc + - go mod tidy script: - go run build.go generate From 426e21c150d9a33e4d8c13c2a13c5234e85f3a0e Mon Sep 17 00:00:00 2001 From: Ajitem Sahasrabuddhe Date: Mon, 9 Sep 2019 13:15:47 +0530 Subject: [PATCH 4/6] Update .travis.yml Set GOPROXY in Travis environment --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index e978823..bfd07ac 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,6 +13,7 @@ os: env: GO111MODULE=on + GOPROXY=https://proxy.golang.org cache: directories: From 534d60bb9bb0476141540ec77c5a3d51e176d162 Mon Sep 17 00:00:00 2001 From: Ajitem Sahasrabuddhe Date: Tue, 10 Sep 2019 06:40:45 +0530 Subject: [PATCH 5/6] Bump minimum supported version of Go to 1.11 --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 38803d6..7d04d20 100644 --- a/go.mod +++ b/go.mod @@ -1,6 +1,6 @@ module github.com/urfave/cli -go 1.10 +go 1.11 require ( github.com/BurntSushi/toml v0.3.1 From 487be14dceb185a3321cacd9bf302f5e811f5ee8 Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Tue, 10 Sep 2019 13:49:11 -0400 Subject: [PATCH 6/6] Don't output hidden commands for man pages Signed-off-by: Michael Crosby --- docs.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs.go b/docs.go index ed79b44..5b94566 100644 --- a/docs.go +++ b/docs.go @@ -57,6 +57,9 @@ func prepareCommands(commands []Command, level int) []string { coms := []string{} for i := range commands { command := &commands[i] + if command.Hidden { + continue + } usage := "" if command.Usage != "" { usage = command.Usage