From eae14fa8d69f5d305dd1f3f2b4f9615f50f5d1f4 Mon Sep 17 00:00:00 2001 From: iwilltry42 Date: Fri, 3 Dec 2021 10:42:04 +0100 Subject: [PATCH] v5.2.0: docgen --- docgen/go.mod | 1 - docgen/go.sum | 7 +++--- docs/usage/commands/k3d_version.md | 1 + docs/usage/commands/k3d_version_list.md | 31 +++++++++++++++++++++++++ 4 files changed, 36 insertions(+), 4 deletions(-) create mode 100644 docs/usage/commands/k3d_version_list.md diff --git a/docgen/go.mod b/docgen/go.mod index 2d7cacee..c415f6ce 100644 --- a/docgen/go.mod +++ b/docgen/go.mod @@ -6,7 +6,6 @@ require ( github.com/google/gofuzz v1.2.0 // indirect github.com/rancher/k3d/v5 v5.0.0-00010101000000-000000000000 github.com/spf13/cobra v1.2.1 - golang.org/x/term v0.0.0-20210406210042-72f3dc4e9b72 // indirect ) replace github.com/rancher/k3d/v5 => /PATH/TO/YOUR/REPO/DIRECTORY diff --git a/docgen/go.sum b/docgen/go.sum index 2d0ec479..edbc3db7 100644 --- a/docgen/go.sum +++ b/docgen/go.sum @@ -484,8 +484,9 @@ github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORR github.com/gorilla/handlers v0.0.0-20150720190736-60c7bfde3e33/go.mod h1:Qkdc/uu4tH4g6mTK6auzZ766c4CA0Ng8+o/OAirnOIQ= github.com/gorilla/mux v1.7.0/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= github.com/gorilla/mux v1.7.2/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= -github.com/gorilla/mux v1.7.3 h1:gnP5JzjVOuiZD07fKKToCAOjS0yOpj/qPETTXCCS6hw= github.com/gorilla/mux v1.7.3/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= +github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI= +github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= github.com/gorilla/websocket v0.0.0-20170926233335-4201258b820c/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= @@ -1149,8 +1150,8 @@ golang.org/x/sys v0.0.0-20211112143042-c6105e7cf70d/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20210406210042-72f3dc4e9b72 h1:VqE9gduFZ4dbR7XoL77lHFp0/DyDUBKSXK7CMFkVcV0= -golang.org/x/term v0.0.0-20210406210042-72f3dc4e9b72/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b h1:9zKuko04nR4gjZ4+DNjHqRlAJqbJETHwiNKDqTfOjfE= +golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= diff --git a/docs/usage/commands/k3d_version.md b/docs/usage/commands/k3d_version.md index 2072847b..dee06c09 100644 --- a/docs/usage/commands/k3d_version.md +++ b/docs/usage/commands/k3d_version.md @@ -27,4 +27,5 @@ k3d version [flags] ### SEE ALSO * [k3d](k3d.md) - https://k3d.io/ -> Run k3s in Docker! +* [k3d version list](k3d_version_list.md) - List k3d/K3s versions diff --git a/docs/usage/commands/k3d_version_list.md b/docs/usage/commands/k3d_version_list.md new file mode 100644 index 00000000..800097ae --- /dev/null +++ b/docs/usage/commands/k3d_version_list.md @@ -0,0 +1,31 @@ +## k3d version list + +List k3d/K3s versions + +``` +k3d version list [flags] +``` + +### Options + +``` + -e, --exclude string Exclude Regexp (default excludes pre-releases and arch-specific tags) (default ".+(rc|engine|alpha|beta|dev|test|arm|arm64|amd64).*") + -f, --format string Output Format (default "raw") + -h, --help help for list + -i, --include string Include Regexp (default includes everything (default ".*") + -l, --limit int Limit number of tags in output (0 = unlimited) + -s, --sort string Sort Mode (asc | desc | off) (default "desc") +``` + +### Options inherited from parent commands + +``` + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) +``` + +### SEE ALSO + +* [k3d version](k3d_version.md) - Show k3d and default k3s version +