diff --git a/go.mod b/go.mod index 027e08fa..71f7fd11 100644 --- a/go.mod +++ b/go.mod @@ -17,7 +17,7 @@ require ( github.com/davecgh/go-spew v1.1.1 github.com/distribution/reference v0.6.0 github.com/docker/cli v28.1.1+incompatible - github.com/docker/cli-docs-tool v0.9.0 + github.com/docker/cli-docs-tool v0.10.0 github.com/docker/docker v28.1.1+incompatible github.com/docker/go-units v0.5.0 github.com/gofrs/flock v0.12.1 diff --git a/go.sum b/go.sum index c6c5b5f9..8d3395a0 100644 --- a/go.sum +++ b/go.sum @@ -110,8 +110,8 @@ github.com/distribution/reference v0.6.0 h1:0IXCQ5g4/QMHHkarYzh5l+u8T3t73zM5Qvfr github.com/distribution/reference v0.6.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E= github.com/docker/cli v28.1.1+incompatible h1:eyUemzeI45DY7eDPuwUcmDyDj1pM98oD5MdSpiItp8k= github.com/docker/cli v28.1.1+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -github.com/docker/cli-docs-tool v0.9.0 h1:CVwQbE+ZziwlPqrJ7LRyUF6GvCA+6gj7MTCsayaK9t0= -github.com/docker/cli-docs-tool v0.9.0/go.mod h1:ClrwlNW+UioiRyH9GiAOe1o3J/TsY3Tr1ipoypjAUtc= +github.com/docker/cli-docs-tool v0.10.0 h1:bOD6mKynPQgojQi3s2jgcUWGp/Ebqy1SeCr9VfKQLLU= +github.com/docker/cli-docs-tool v0.10.0/go.mod h1:5EM5zPnT2E7yCLERZmrDA234Vwn09fzRHP4aX1qwp1U= github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/distribution v2.8.3+incompatible h1:AtKxIZ36LoNK51+Z6RpzLpddBirtxJnzDrHLEKxTAYk= github.com/docker/distribution v2.8.3+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= diff --git a/vendor/github.com/docker/cli-docs-tool/.golangci.yml b/vendor/github.com/docker/cli-docs-tool/.golangci.yml index 56a199fd..d807400e 100644 --- a/vendor/github.com/docker/cli-docs-tool/.golangci.yml +++ b/vendor/github.com/docker/cli-docs-tool/.golangci.yml @@ -1,34 +1,38 @@ -run: - timeout: 10m +version: "2" linters: + default: none enable: - depguard - - gofmt - - goimports - revive - govet - importas - ineffassign - misspell - - typecheck - errname - makezero - whitespace - disable-all: true - -linters-settings: - depguard: + settings: + depguard: + rules: + main: + deny: + - pkg: io/ioutil + desc: The io/ioutil package has been deprecated, see https://go.dev/doc/go1.16#ioutil + importas: + no-unaliased: true + exclusions: + generated: lax rules: - main: - deny: - - pkg: io/ioutil - desc: The io/ioutil package has been deprecated, see https://go.dev/doc/go1.16#ioutil - importas: - no-unaliased: true + - linters: + - revive + text: stutters + +formatters: + enable: + - gofmt + - goimports issues: - exclude-rules: - - linters: - - revive - text: "stutters" + max-issues-per-linter: 0 + max-same-issues: 0 diff --git a/vendor/github.com/docker/cli-docs-tool/Dockerfile b/vendor/github.com/docker/cli-docs-tool/Dockerfile index b075df29..1c36a9e0 100644 --- a/vendor/github.com/docker/cli-docs-tool/Dockerfile +++ b/vendor/github.com/docker/cli-docs-tool/Dockerfile @@ -14,9 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. -ARG GO_VERSION="1.23" +ARG GO_VERSION="1.24" ARG XX_VERSION="1.6.1" -ARG GOLANGCI_LINT_VERSION="v1.62" +ARG GOLANGCI_LINT_VERSION="v2.1.5" ARG ADDLICENSE_VERSION="v1.1.1" ARG LICENSE_ARGS="-c cli-docs-tool -l apache" diff --git a/vendor/github.com/docker/cli-docs-tool/annotation/annotation.go b/vendor/github.com/docker/cli-docs-tool/annotation/annotation.go index 021846af..ebc1ed23 100644 --- a/vendor/github.com/docker/cli-docs-tool/annotation/annotation.go +++ b/vendor/github.com/docker/cli-docs-tool/annotation/annotation.go @@ -12,6 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package annotation handles annotations for CLI commands. package annotation const ( diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool.go b/vendor/github.com/docker/cli-docs-tool/clidocstool.go index 5b25de00..cee6dbe1 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool.go @@ -12,6 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package clidocstool provides tools for generating CLI documentation. package clidocstool import ( diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool_man.go b/vendor/github.com/docker/cli-docs-tool/clidocstool_man.go index e043f993..1b085f16 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool_man.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool_man.go @@ -64,6 +64,14 @@ func (c *Client) genManTreeCustom(cmd *cobra.Command) error { return nil } + // Skip hidden command recursively + for curr := cmd; curr != nil; curr = curr.Parent() { + if curr.Hidden { + log.Printf("INFO: Skipping Man for %q (hidden command)", curr.CommandPath()) + return nil + } + } + log.Printf("INFO: Generating Man for %q", cmd.CommandPath()) return doc.GenManTreeFromOpts(cmd, doc.GenManTreeOptions{ diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go b/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go index 46c2d093..4d524057 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go @@ -53,10 +53,12 @@ func (c *Client) GenMarkdownTree(cmd *cobra.Command) error { return nil } - // Skip hidden command - if cmd.Hidden { - log.Printf("INFO: Skipping Markdown for %q (hidden command)", cmd.CommandPath()) - return nil + // Skip hidden command recursively + for curr := cmd; curr != nil; curr = curr.Parent() { + if curr.Hidden { + log.Printf("INFO: Skipping Markdown for %q (hidden command)", curr.CommandPath()) + return nil + } } log.Printf("INFO: Generating Markdown for %q", cmd.CommandPath()) diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go b/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go index 2add1e6c..cee53e5a 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go @@ -169,6 +169,9 @@ func (c *Client) genYamlCustom(cmd *cobra.Command, w io.Writer) error { // check recursively to handle inherited annotations for curr := cmd; curr != nil; curr = curr.Parent() { + if curr.Hidden { + cliDoc.Hidden = true + } if v, ok := curr.Annotations["version"]; ok && cliDoc.MinAPIVersion == "" { cliDoc.MinAPIVersion = v } @@ -349,9 +352,9 @@ func genFlagResult(cmd *cobra.Command, flags *pflag.FlagSet, anchors map[string] // // This makes the generated YAML more readable, and easier to review changes. // max can be used to customize the width to keep the whole line < 80 chars. -func forceMultiLine(s string, max int) string { +func forceMultiLine(s string, maxWidth int) string { s = strings.TrimSpace(s) - if len(s) > max && !strings.Contains(s, "\n") { + if len(s) > maxWidth && !strings.Contains(s, "\n") { s = s + "\n" } return s diff --git a/vendor/modules.txt b/vendor/modules.txt index 084b3102..3376fa4a 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -250,8 +250,8 @@ github.com/docker/cli/internal/tui github.com/docker/cli/opts github.com/docker/cli/pkg/kvfile github.com/docker/cli/templates -# github.com/docker/cli-docs-tool v0.9.0 -## explicit; go 1.18 +# github.com/docker/cli-docs-tool v0.10.0 +## explicit; go 1.23.0 github.com/docker/cli-docs-tool github.com/docker/cli-docs-tool/annotation # github.com/docker/distribution v2.8.3+incompatible