From 7544ec57a119ae86c521336ab09d031a26279828 Mon Sep 17 00:00:00 2001 From: bupd Date: Sun, 26 May 2024 11:31:41 +0530 Subject: [PATCH 1/8] add: auto man documentation generate scripts Signed-off-by: bupd add: auto documentation generate scripts Signed-off-by: bupd --- doc/man_doc.go | 44 ++++++++++++++++++++++++++++++++++++++++++++ doc/md_doc.go | 33 +++++++++++++++++++++++++++++++++ go.mod | 45 ++++++++++++++++++++++++--------------------- go.sum | 50 ++++++++++++++++++++++++++++++++++++++++++++++++-- 4 files changed, 149 insertions(+), 23 deletions(-) create mode 100644 doc/man_doc.go create mode 100644 doc/md_doc.go diff --git a/doc/man_doc.go b/doc/man_doc.go new file mode 100644 index 00000000..60f894bb --- /dev/null +++ b/doc/man_doc.go @@ -0,0 +1,44 @@ +package main + +import ( + "fmt" + "os" + "time" + + cmd "github.com/goharbor/harbor-cli/cmd/harbor/root" + "github.com/spf13/cobra/doc" +) + +func main() { + // create temporary dir in currentDir for documents. + // Assuming you are executing from the main directory. + currentDir, err := os.Getwd() + if err != nil { + fmt.Println(err) + } + docDir := fmt.Sprintf("%s/%s", currentDir, "doc/man_docs/") + os.RemoveAll(docDir) + err = os.MkdirAll(docDir, os.ModePerm) + if err != nil { + fmt.Println("Error creating docs directory:", err) + os.Exit(1) + } + + t := time.Now() + + header := &doc.GenManHeader{ + Title: "HARBOR", + Section: "1", + Source: "Habor Community", + Manual: "Harbor User Mannuals", + Date: &t, + } + + err = doc.GenManTree(cmd.RootCmd(), header, docDir) + if err != nil { + fmt.Println("Error generating documentation:", err) + os.Exit(1) + } + + fmt.Println("Documentation generated successfully in", docDir) +} diff --git a/doc/md_doc.go b/doc/md_doc.go new file mode 100644 index 00000000..f5e3f6b7 --- /dev/null +++ b/doc/md_doc.go @@ -0,0 +1,33 @@ +package main + +import ( + "fmt" + "os" + + cmd "github.com/goharbor/harbor-cli/cmd/harbor/root" + "github.com/spf13/cobra/doc" +) + +func main() { + // create temporary dir in currentDir for documents. + // Assuming you are executing from the main directory. + currentDir, err := os.Getwd() + if err != nil { + fmt.Println(err) + } + docDir := fmt.Sprintf("%s/%s", currentDir, "doc/md_docs/") + os.RemoveAll(docDir) + err = os.MkdirAll(docDir, os.ModePerm) + if err != nil { + fmt.Println("Error creating docs directory:", err) + os.Exit(1) + } + + err = doc.GenMarkdownTree(cmd.RootCmd(), docDir) + if err != nil { + fmt.Println("Error generating documentation:", err) + os.Exit(1) + } + + fmt.Println("Documentation generated successfully in", docDir) +} diff --git a/go.mod b/go.mod index 0bf4138e..5d61eb80 100644 --- a/go.mod +++ b/go.mod @@ -4,14 +4,14 @@ go 1.22.5 require ( github.com/charmbracelet/bubbles v0.20.0 - github.com/charmbracelet/bubbletea v1.1.0 + github.com/charmbracelet/bubbletea v1.2.4 github.com/charmbracelet/huh v0.6.0 - github.com/charmbracelet/lipgloss v0.13.0 + github.com/charmbracelet/lipgloss v1.0.0 github.com/sirupsen/logrus v1.9.3 github.com/spf13/cobra v1.8.1 github.com/spf13/viper v1.19.0 - github.com/stretchr/testify v1.9.0 - golang.org/x/term v0.6.0 + github.com/stretchr/testify v1.10.0 + golang.org/x/term v0.27.0 gopkg.in/yaml.v3 v3.0.1 ) @@ -19,16 +19,17 @@ require ( github.com/atotto/clipboard v0.1.4 // indirect github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect github.com/catppuccin/go v0.2.0 // indirect - github.com/charmbracelet/x/ansi v0.2.3 // indirect - github.com/charmbracelet/x/exp/strings v0.0.0-20240725160154-f9f6568126ec // indirect - github.com/charmbracelet/x/term v0.2.0 // indirect + github.com/charmbracelet/x/ansi v0.6.0 // indirect + github.com/charmbracelet/x/exp/strings v0.0.0-20241222104055-e1130b311607 // indirect + github.com/charmbracelet/x/term v0.2.1 // indirect + github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect github.com/dustin/go-humanize v1.0.1 // indirect github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect - github.com/fsnotify/fsnotify v1.7.0 // indirect + github.com/fsnotify/fsnotify v1.8.0 // indirect github.com/hashicorp/hcl v1.0.0 // indirect github.com/lucasb-eyer/go-colorful v1.2.0 // indirect - github.com/magiconair/properties v1.8.7 // indirect + github.com/magiconair/properties v1.8.9 // indirect github.com/mattn/go-isatty v0.0.20 // indirect github.com/mattn/go-localereader v0.0.1 // indirect github.com/mattn/go-runewidth v0.0.16 // indirect @@ -36,20 +37,22 @@ require ( github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect github.com/muesli/cancelreader v0.2.2 // indirect github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a // indirect - github.com/pelletier/go-toml/v2 v2.2.2 // indirect + github.com/pelletier/go-toml/v2 v2.2.3 // indirect github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect github.com/rivo/uniseg v0.4.7 // indirect - github.com/rogpeppe/go-internal v1.12.0 // indirect + github.com/rogpeppe/go-internal v1.13.1 // indirect + github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/sagikazarmark/locafero v0.6.0 // indirect github.com/sagikazarmark/slog-shim v0.1.0 // indirect github.com/sahilm/fuzzy v0.1.1 // indirect github.com/sourcegraph/conc v0.3.0 // indirect github.com/spf13/afero v1.11.0 // indirect - github.com/spf13/cast v1.6.0 // indirect + github.com/spf13/cast v1.7.1 // indirect github.com/subosito/gotenv v1.6.0 // indirect + go.opentelemetry.io/auto/sdk v1.1.0 // indirect go.uber.org/multierr v1.11.0 // indirect - golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect - golang.org/x/sync v0.8.0 // indirect + golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67 // indirect + golang.org/x/sync v0.10.0 // indirect gopkg.in/ini.v1 v1.67.0 // indirect ) @@ -71,18 +74,18 @@ require ( github.com/google/uuid v1.6.0 // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/josharian/intern v1.0.0 // indirect - github.com/mailru/easyjson v0.7.7 // indirect + github.com/mailru/easyjson v0.9.0 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/oklog/ulid v1.3.1 // indirect github.com/opentracing/opentracing-go v1.2.0 // indirect github.com/spf13/pflag v1.0.5 // indirect - go.mongodb.org/mongo-driver v1.16.0 // indirect - go.opentelemetry.io/otel v1.31.0 // indirect - go.opentelemetry.io/otel/metric v1.31.0 // indirect + go.mongodb.org/mongo-driver v1.17.1 // indirect + go.opentelemetry.io/otel v1.33.0 // indirect + go.opentelemetry.io/otel/metric v1.33.0 // indirect go.opentelemetry.io/otel/sdk v1.28.0 // indirect - go.opentelemetry.io/otel/trace v1.31.0 // indirect - golang.org/x/sys v0.25.0 // indirect - golang.org/x/text v0.18.0 // indirect + go.opentelemetry.io/otel/trace v1.33.0 // indirect + golang.org/x/sys v0.28.0 // indirect + golang.org/x/text v0.21.0 // indirect ) replace go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc => go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc v0.0.0-20240518090000-14441aefdf88 diff --git a/go.sum b/go.sum index 599c9bbc..18316416 100644 --- a/go.sum +++ b/go.sum @@ -14,19 +14,32 @@ github.com/charmbracelet/bubbles v0.20.0 h1:jSZu6qD8cRQ6k9OMfR1WlM+ruM8fkPWkHvQW github.com/charmbracelet/bubbles v0.20.0/go.mod h1:39slydyswPy+uVOHZ5x/GjwVAFkCsV8IIVy+4MhzwwU= github.com/charmbracelet/bubbletea v1.1.0 h1:FjAl9eAL3HBCHenhz/ZPjkKdScmaS5SK69JAK2YJK9c= github.com/charmbracelet/bubbletea v1.1.0/go.mod h1:9Ogk0HrdbHolIKHdjfFpyXJmiCzGwy+FesYkZr7hYU4= +github.com/charmbracelet/bubbletea v1.2.4 h1:KN8aCViA0eps9SCOThb2/XPIlea3ANJLUkv3KnQRNCE= +github.com/charmbracelet/bubbletea v1.2.4/go.mod h1:Qr6fVQw+wX7JkWWkVyXYk/ZUQ92a6XNekLXa3rR18MM= github.com/charmbracelet/huh v0.6.0 h1:mZM8VvZGuE0hoDXq6XLxRtgfWyTI3b2jZNKh0xWmax8= github.com/charmbracelet/huh v0.6.0/go.mod h1:GGNKeWCeNzKpEOh/OJD8WBwTQjV3prFAtQPpLv+AVwU= github.com/charmbracelet/lipgloss v0.13.0 h1:4X3PPeoWEDCMvzDvGmTajSyYPcZM4+y8sCA/SsA3cjw= github.com/charmbracelet/lipgloss v0.13.0/go.mod h1:nw4zy0SBX/F/eAO1cWdcvy6qnkDUxr8Lw7dvFrAIbbY= +github.com/charmbracelet/lipgloss v1.0.0 h1:O7VkGDvqEdGi93X+DeqsQ7PKHDgtQfF8j8/O2qFMQNg= +github.com/charmbracelet/lipgloss v1.0.0/go.mod h1:U5fy9Z+C38obMs+T+tJqst9VGzlOYGj4ri9reL3qUlo= github.com/charmbracelet/x/ansi v0.2.3 h1:VfFN0NUpcjBRd4DnKfRaIRo53KRgey/nhOoEqosGDEY= github.com/charmbracelet/x/ansi v0.2.3/go.mod h1:dk73KoMTT5AX5BsX0KrqhsTqAnhZZoCBjs7dGWp4Ktw= +github.com/charmbracelet/x/ansi v0.6.0 h1:qOznutrb93gx9oMiGf7caF7bqqubh6YIM0SWKyA08pA= +github.com/charmbracelet/x/ansi v0.6.0/go.mod h1:KBUFw1la39nl0dLl10l5ORDAqGXaeurTQmwyyVKse/Q= github.com/charmbracelet/x/exp/golden v0.0.0-20240815200342-61de596daa2b h1:MnAMdlwSltxJyULnrYbkZpp4k58Co7Tah3ciKhSNo0Q= github.com/charmbracelet/x/exp/golden v0.0.0-20240815200342-61de596daa2b/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U= -github.com/charmbracelet/x/exp/strings v0.0.0-20240725160154-f9f6568126ec h1:G79PnmxvVeo5FbAip3VPqAaBkOeXExwvhIBUfrXD5MA= -github.com/charmbracelet/x/exp/strings v0.0.0-20240725160154-f9f6568126ec/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ= +github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 h1:qko3AQ4gK1MTS/de7F5hPGx6/k1u0w4TeYmBFwzYVP4= +github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ= +github.com/charmbracelet/x/exp/strings v0.0.0-20241222104055-e1130b311607 h1:D5Di9oyZpU7yeL2wkc5E4VaCXyg+8QYYN4kxMsLufDs= +github.com/charmbracelet/x/exp/strings v0.0.0-20241222104055-e1130b311607/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ= github.com/charmbracelet/x/term v0.2.0 h1:cNB9Ot9q8I711MyZ7myUR5HFWL/lc3OpU8jZ4hwm0x0= github.com/charmbracelet/x/term v0.2.0/go.mod h1:GVxgxAbjUrmpvIINHIQnJJKpMlHiZ4cktEQCN6GWyF0= +github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ= +github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg= +github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4= github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/cpuguy83/go-md2man/v2 v2.0.6 h1:XJtiaUW6dEEqVuZiMTn1ldk455QWwEIsMIJlo5vtkx0= +github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= @@ -39,6 +52,8 @@ github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHk github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0= github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA= github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM= +github.com/fsnotify/fsnotify v1.8.0 h1:dAwr6QBTBZIkG8roQaJjGof0pp0EeF+tNV7YBP3F/8M= +github.com/fsnotify/fsnotify v1.8.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= @@ -86,8 +101,12 @@ github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY= github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0= +github.com/magiconair/properties v1.8.9 h1:nWcCbLq1N2v/cpNsy5WvQ37Fb+YElfq20WJ/a8RkpQM= +github.com/magiconair/properties v1.8.9/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0= github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0= github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= +github.com/mailru/easyjson v0.9.0 h1:PrnmzHw7262yW8sTBwxi1PdJA3Iw/EKBa8psRf7d9a4= +github.com/mailru/easyjson v0.9.0/go.mod h1:1+xMtQp2MRNVL/V1bOzuP3aP8VNwRW55fQUto+XFtTU= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4= @@ -110,6 +129,8 @@ github.com/opentracing/opentracing-go v1.2.0 h1:uEJPy/1a5RIPAJ0Ov+OIO8OxWu77jEv+ github.com/opentracing/opentracing-go v1.2.0/go.mod h1:GxEUsuufX4nBwe+T+Wl9TAgYrxe9dPLANfrWvHYVTgc= github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM= github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs= +github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M= +github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= @@ -118,6 +139,8 @@ github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8= github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4= +github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o= +github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sagikazarmark/locafero v0.6.0 h1:ON7AQg37yzcRPU69mt7gwhFEBwxI6P9T4Qu3N51bwOk= github.com/sagikazarmark/locafero v0.6.0/go.mod h1:77OmuIc6VTraTXKXIs/uvUxKGUXjE1GbemJYHqdNjX0= @@ -133,6 +156,8 @@ github.com/spf13/afero v1.11.0 h1:WJQKhtpdm3v2IzqG8VMqrr6Rf3UYpEF239Jy9wNepM8= github.com/spf13/afero v1.11.0/go.mod h1:GH9Y3pIexgf1MTIWtNGyogA5MwRIDXGUr+hbWNoBjkY= github.com/spf13/cast v1.6.0 h1:GEiTHELF+vaR5dhz3VqZfFSzZjYbgeKDpBxQVS4GYJ0= github.com/spf13/cast v1.6.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo= +github.com/spf13/cast v1.7.1 h1:cuNEagBQEHWN1FnbGEjCXL2szYEXqfJPbP2HNUaca9Y= +github.com/spf13/cast v1.7.1/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo= github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM= github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= @@ -150,33 +175,54 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8= github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU= go.mongodb.org/mongo-driver v1.16.0 h1:tpRsfBJMROVHKpdGyc1BBEzzjDUWjItxbVSZ8Ls4BQ4= go.mongodb.org/mongo-driver v1.16.0/go.mod h1:oB6AhJQvFQL4LEHyXi6aJzQJtBiTQHiAd83l0GdFaiw= +go.mongodb.org/mongo-driver v1.17.1 h1:Wic5cJIwJgSpBhe3lx3+/RybR5PiYRMpVFgO7cOHyIM= +go.mongodb.org/mongo-driver v1.17.1/go.mod h1:wwWm/+BuOddhcq3n68LKRmgk2wXzmF6s0SFOa0GINL4= +go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= +go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= go.opentelemetry.io/otel v1.31.0 h1:NsJcKPIW0D0H3NgzPDHmo0WW6SptzPdqg/L1zsIm2hY= go.opentelemetry.io/otel v1.31.0/go.mod h1:O0C14Yl9FgkjqcCZAsE053C13OaddMYr/hz6clDkEJE= +go.opentelemetry.io/otel v1.33.0 h1:/FerN9bax5LoK51X/sI0SVYrjSE0/yUL7DpxW4K3FWw= +go.opentelemetry.io/otel v1.33.0/go.mod h1:SUUkR6csvUQl+yjReHu5uM3EtVV7MBm5FHKRlNx4I8I= go.opentelemetry.io/otel/metric v1.31.0 h1:FSErL0ATQAmYHUIzSezZibnyVlft1ybhy4ozRPcF2fE= go.opentelemetry.io/otel/metric v1.31.0/go.mod h1:C3dEloVbLuYoX41KpmAhOqNriGbA+qqH6PQ5E5mUfnY= +go.opentelemetry.io/otel/metric v1.33.0 h1:r+JOocAyeRVXD8lZpjdQjzMadVZp2M4WmQ+5WtEnklQ= +go.opentelemetry.io/otel/metric v1.33.0/go.mod h1:L9+Fyctbp6HFTddIxClbQkjtubW6O9QS3Ann/M82u6M= go.opentelemetry.io/otel/sdk v1.28.0 h1:b9d7hIry8yZsgtbmM0DKyPWMMUMlK9NEKuIG4aBqWyE= go.opentelemetry.io/otel/sdk v1.28.0/go.mod h1:oYj7ClPUA7Iw3m+r7GeEjz0qckQRJK2B8zjcZEfu7Pg= go.opentelemetry.io/otel/trace v1.31.0 h1:ffjsj1aRouKewfr85U2aGagJ46+MvodynlQ1HYdmJys= go.opentelemetry.io/otel/trace v1.31.0/go.mod h1:TXZkRk7SM2ZQLtR6eoAWQFIHPvzQ06FJAsO1tJg480A= +go.opentelemetry.io/otel/trace v1.33.0 h1:cCJuF7LRjUFso9LPnEAHJDB2pqzp+hbO8eu1qqW2d/s= +go.opentelemetry.io/otel/trace v1.33.0/go.mod h1:uIcdVUZMpTAmz0tI1z04GoVSezK37CbGV4fr1f2nBck= go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 h1:2dVuKD2vS7b0QIHQbpyTISPd0LeHDbnYEryqj5Q1ug8= golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56/go.mod h1:M4RDyNAINzryxdtnbRXRL/OHtkFuWGRjvuhBJpk2IlY= +golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67 h1:1UoZQm6f0P/ZO0w1Ri+f+ifG/gXhegadRdwBIXEFWDo= +golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67/go.mod h1:qj5a5QZpwLU2NLQudwIN5koi3beDhSAlJwa67PuM98c= golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ= golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ= +golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34= golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= +golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.6.0 h1:clScbb1cHjoCkyRbWwBEUZ5H/tIFu5TAXIqaZD0Gcjw= golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= +golang.org/x/term v0.27.0 h1:WP60Sv1nlK1T6SupCHbXzSaN0b9wUmsPoRS9b61A23Q= +golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224= golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY= +golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo= +golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= From 3b33ccc3a49641100b9f614fb9530f43fa65639d Mon Sep 17 00:00:00 2001 From: bupd Date: Thu, 25 Jul 2024 08:21:20 +0530 Subject: [PATCH 2/8] remove md_doc generation & add man docs Signed-off-by: bupd --- doc/man_docs/harbor-artifact-delete.1 | 41 ++++++++++++ doc/man_docs/harbor-artifact-info.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact-list.1 | 41 ++++++++++++ doc/man_docs/harbor-artifact-scan-start.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact-scan-stop.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact-scan.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact-tags-create.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact-tags-delete.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact-tags-list.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact-tags.1 | 47 ++++++++++++++ doc/man_docs/harbor-artifact.1 | 47 ++++++++++++++ doc/man_docs/harbor-login.1 | 53 ++++++++++++++++ doc/man_docs/harbor-project-create.1 | 61 ++++++++++++++++++ doc/man_docs/harbor-project-delete.1 | 41 ++++++++++++ doc/man_docs/harbor-project-list.1 | 65 +++++++++++++++++++ doc/man_docs/harbor-project-logs.1 | 41 ++++++++++++ doc/man_docs/harbor-project-view.1 | 41 ++++++++++++ doc/man_docs/harbor-project.1 | 47 ++++++++++++++ doc/man_docs/harbor-registry-create.1 | 73 ++++++++++++++++++++++ doc/man_docs/harbor-registry-delete.1 | 41 ++++++++++++ doc/man_docs/harbor-registry-info.1 | 41 ++++++++++++ doc/man_docs/harbor-registry-list.1 | 57 +++++++++++++++++ doc/man_docs/harbor-registry-update.1 | 73 ++++++++++++++++++++++ doc/man_docs/harbor-registry-view.1 | 41 ++++++++++++ doc/man_docs/harbor-registry.1 | 47 ++++++++++++++ doc/man_docs/harbor-repo-delete.1 | 47 ++++++++++++++ doc/man_docs/harbor-repo-info.1 | 47 ++++++++++++++ doc/man_docs/harbor-repo-list.1 | 41 ++++++++++++ doc/man_docs/harbor-repo.1 | 41 ++++++++++++ doc/man_docs/harbor-user-create.1 | 61 ++++++++++++++++++ doc/man_docs/harbor-user-delete.1 | 41 ++++++++++++ doc/man_docs/harbor-user-elevate.1 | 41 ++++++++++++ doc/man_docs/harbor-user-list.1 | 41 ++++++++++++ doc/man_docs/harbor-user.1 | 47 ++++++++++++++ doc/man_docs/harbor-version.1 | 47 ++++++++++++++ doc/man_docs/harbor.1 | 51 +++++++++++++++ doc/md_doc.go | 33 ---------- go.mod | 1 - go.sum | 51 +-------------- 39 files changed, 1734 insertions(+), 83 deletions(-) create mode 100644 doc/man_docs/harbor-artifact-delete.1 create mode 100644 doc/man_docs/harbor-artifact-info.1 create mode 100644 doc/man_docs/harbor-artifact-list.1 create mode 100644 doc/man_docs/harbor-artifact-scan-start.1 create mode 100644 doc/man_docs/harbor-artifact-scan-stop.1 create mode 100644 doc/man_docs/harbor-artifact-scan.1 create mode 100644 doc/man_docs/harbor-artifact-tags-create.1 create mode 100644 doc/man_docs/harbor-artifact-tags-delete.1 create mode 100644 doc/man_docs/harbor-artifact-tags-list.1 create mode 100644 doc/man_docs/harbor-artifact-tags.1 create mode 100644 doc/man_docs/harbor-artifact.1 create mode 100644 doc/man_docs/harbor-login.1 create mode 100644 doc/man_docs/harbor-project-create.1 create mode 100644 doc/man_docs/harbor-project-delete.1 create mode 100644 doc/man_docs/harbor-project-list.1 create mode 100644 doc/man_docs/harbor-project-logs.1 create mode 100644 doc/man_docs/harbor-project-view.1 create mode 100644 doc/man_docs/harbor-project.1 create mode 100644 doc/man_docs/harbor-registry-create.1 create mode 100644 doc/man_docs/harbor-registry-delete.1 create mode 100644 doc/man_docs/harbor-registry-info.1 create mode 100644 doc/man_docs/harbor-registry-list.1 create mode 100644 doc/man_docs/harbor-registry-update.1 create mode 100644 doc/man_docs/harbor-registry-view.1 create mode 100644 doc/man_docs/harbor-registry.1 create mode 100644 doc/man_docs/harbor-repo-delete.1 create mode 100644 doc/man_docs/harbor-repo-info.1 create mode 100644 doc/man_docs/harbor-repo-list.1 create mode 100644 doc/man_docs/harbor-repo.1 create mode 100644 doc/man_docs/harbor-user-create.1 create mode 100644 doc/man_docs/harbor-user-delete.1 create mode 100644 doc/man_docs/harbor-user-elevate.1 create mode 100644 doc/man_docs/harbor-user-list.1 create mode 100644 doc/man_docs/harbor-user.1 create mode 100644 doc/man_docs/harbor-version.1 create mode 100644 doc/man_docs/harbor.1 delete mode 100644 doc/md_doc.go diff --git a/doc/man_docs/harbor-artifact-delete.1 b/doc/man_docs/harbor-artifact-delete.1 new file mode 100644 index 00000000..1db46c26 --- /dev/null +++ b/doc/man_docs/harbor-artifact-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-delete - delete an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact delete [flags]\fP + + +.SH DESCRIPTION +.PP +delete an artifact + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for delete + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-artifact(1)\fP diff --git a/doc/man_docs/harbor-artifact-info.1 b/doc/man_docs/harbor-artifact-info.1 new file mode 100644 index 00000000..16be12b2 --- /dev/null +++ b/doc/man_docs/harbor-artifact-info.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-info - Get info of an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact info [flags]\fP + + +.SH DESCRIPTION +.PP +Get info of an artifact + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for info + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact info // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact(1)\fP diff --git a/doc/man_docs/harbor-artifact-list.1 b/doc/man_docs/harbor-artifact-list.1 new file mode 100644 index 00000000..315aad31 --- /dev/null +++ b/doc/man_docs/harbor-artifact-list.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-list - list artifacts within a repository + + +.SH SYNOPSIS +.PP +\fBharbor artifact list [flags]\fP + + +.SH DESCRIPTION +.PP +list artifacts within a repository + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for list + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-artifact(1)\fP diff --git a/doc/man_docs/harbor-artifact-scan-start.1 b/doc/man_docs/harbor-artifact-scan-start.1 new file mode 100644 index 00000000..453e0c50 --- /dev/null +++ b/doc/man_docs/harbor-artifact-scan-start.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-scan-start - Start a scan of an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact scan start [flags]\fP + + +.SH DESCRIPTION +.PP +Start a scan of an artifact in Harbor Repository + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for start + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact scan start // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-scan(1)\fP diff --git a/doc/man_docs/harbor-artifact-scan-stop.1 b/doc/man_docs/harbor-artifact-scan-stop.1 new file mode 100644 index 00000000..1e105f46 --- /dev/null +++ b/doc/man_docs/harbor-artifact-scan-stop.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-scan-stop - Stop a scan of an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact scan stop [flags]\fP + + +.SH DESCRIPTION +.PP +Stop a scan of an artifact in Harbor Repository + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for stop + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact scan stop // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-scan(1)\fP diff --git a/doc/man_docs/harbor-artifact-scan.1 b/doc/man_docs/harbor-artifact-scan.1 new file mode 100644 index 00000000..4fc13c45 --- /dev/null +++ b/doc/man_docs/harbor-artifact-scan.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-scan - Scan an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact scan [flags]\fP + + +.SH DESCRIPTION +.PP +Scan an artifact in Harbor Repository + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for scan + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact scan start // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact(1)\fP, \fBharbor-artifact-scan-start(1)\fP, \fBharbor-artifact-scan-stop(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags-create.1 b/doc/man_docs/harbor-artifact-tags-create.1 new file mode 100644 index 00000000..a2d74c03 --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags-create.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-tags-create - Create a tag of an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact tags create [flags]\fP + + +.SH DESCRIPTION +.PP +Create a tag of an artifact + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact tags create // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-tags(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags-delete.1 b/doc/man_docs/harbor-artifact-tags-delete.1 new file mode 100644 index 00000000..5227d295 --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags-delete.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-tags-delete - Delete a tag of an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact tags delete [flags]\fP + + +.SH DESCRIPTION +.PP +Delete a tag of an artifact + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for delete + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact tags delete // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-tags(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags-list.1 b/doc/man_docs/harbor-artifact-tags-list.1 new file mode 100644 index 00000000..4d07a853 --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags-list.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-tags-list - List tags of an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact tags list [flags]\fP + + +.SH DESCRIPTION +.PP +List tags of an artifact + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for list + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact tags list // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-tags(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags.1 b/doc/man_docs/harbor-artifact-tags.1 new file mode 100644 index 00000000..3ddf8bba --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact-tags - Manage tags of an artifact + + +.SH SYNOPSIS +.PP +\fBharbor artifact tags [flags]\fP + + +.SH DESCRIPTION +.PP +Manage tags of an artifact + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for tags + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor artifact tags list // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact(1)\fP, \fBharbor-artifact-tags-create(1)\fP, \fBharbor-artifact-tags-delete(1)\fP, \fBharbor-artifact-tags-list(1)\fP diff --git a/doc/man_docs/harbor-artifact.1 b/doc/man_docs/harbor-artifact.1 new file mode 100644 index 00000000..55ac01d3 --- /dev/null +++ b/doc/man_docs/harbor-artifact.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-artifact - Manage artifacts + + +.SH SYNOPSIS +.PP +\fBharbor artifact [flags]\fP + + +.SH DESCRIPTION +.PP +Manage artifacts in Harbor Repository + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for artifact + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor artifact list +.EE + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP, \fBharbor-artifact-delete(1)\fP, \fBharbor-artifact-info(1)\fP, \fBharbor-artifact-list(1)\fP, \fBharbor-artifact-scan(1)\fP, \fBharbor-artifact-tags(1)\fP diff --git a/doc/man_docs/harbor-login.1 b/doc/man_docs/harbor-login.1 new file mode 100644 index 00000000..015946a6 --- /dev/null +++ b/doc/man_docs/harbor-login.1 @@ -0,0 +1,53 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-login - Log in to Harbor registry + + +.SH SYNOPSIS +.PP +\fBharbor login [server] [flags]\fP + + +.SH DESCRIPTION +.PP +Authenticate with Harbor Registry. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for login + +.PP +\fB--name\fP="" + name for the set of credentials + +.PP +\fB-p\fP, \fB--password\fP="" + Password + +.PP +\fB-u\fP, \fB--username\fP="" + Username + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP diff --git a/doc/man_docs/harbor-project-create.1 b/doc/man_docs/harbor-project-create.1 new file mode 100644 index 00000000..ed05c0e1 --- /dev/null +++ b/doc/man_docs/harbor-project-create.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-project-create - create project + + +.SH SYNOPSIS +.PP +\fBharbor project create [flags]\fP + + +.SH DESCRIPTION +.PP +create project + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + +.PP +\fB--name\fP="" + Name of the project + +.PP +\fB--proxy-cache\fP[=false] + Whether the project is a proxy cache project + +.PP +\fB--public\fP[=false] + Project is public or private. Private by default + +.PP +\fB--registry-id\fP="" + ID of referenced registry when creating the proxy cache project + +.PP +\fB--storage-limit\fP="-1" + Storage quota of the project + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-project(1)\fP diff --git a/doc/man_docs/harbor-project-delete.1 b/doc/man_docs/harbor-project-delete.1 new file mode 100644 index 00000000..80d67878 --- /dev/null +++ b/doc/man_docs/harbor-project-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-project-delete - delete project by name or id + + +.SH SYNOPSIS +.PP +\fBharbor project delete [flags]\fP + + +.SH DESCRIPTION +.PP +delete project by name or id + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for delete + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-project(1)\fP diff --git a/doc/man_docs/harbor-project-list.1 b/doc/man_docs/harbor-project-list.1 new file mode 100644 index 00000000..198a6561 --- /dev/null +++ b/doc/man_docs/harbor-project-list.1 @@ -0,0 +1,65 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-project-list - list project + + +.SH SYNOPSIS +.PP +\fBharbor project list [flags]\fP + + +.SH DESCRIPTION +.PP +list project + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB--name\fP="" + Name of the project + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=10 + Size of per page + +.PP +\fB--public\fP[=false] + Project is public or private + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-project(1)\fP diff --git a/doc/man_docs/harbor-project-logs.1 b/doc/man_docs/harbor-project-logs.1 new file mode 100644 index 00000000..6293920e --- /dev/null +++ b/doc/man_docs/harbor-project-logs.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-project-logs - get project logs + + +.SH SYNOPSIS +.PP +\fBharbor project logs [flags]\fP + + +.SH DESCRIPTION +.PP +get project logs + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for logs + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-project(1)\fP diff --git a/doc/man_docs/harbor-project-view.1 b/doc/man_docs/harbor-project-view.1 new file mode 100644 index 00000000..c987ed89 --- /dev/null +++ b/doc/man_docs/harbor-project-view.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-project-view - get project by name or id + + +.SH SYNOPSIS +.PP +\fBharbor project view [NAME|ID] [flags]\fP + + +.SH DESCRIPTION +.PP +get project by name or id + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for view + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-project(1)\fP diff --git a/doc/man_docs/harbor-project.1 b/doc/man_docs/harbor-project.1 new file mode 100644 index 00000000..19242e0d --- /dev/null +++ b/doc/man_docs/harbor-project.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-project - Manage projects and assign resources to them + + +.SH SYNOPSIS +.PP +\fBharbor project [flags]\fP + + +.SH DESCRIPTION +.PP +Manage projects in Harbor + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for project + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor project list +.EE + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP, \fBharbor-project-create(1)\fP, \fBharbor-project-delete(1)\fP, \fBharbor-project-list(1)\fP, \fBharbor-project-logs(1)\fP, \fBharbor-project-view(1)\fP diff --git a/doc/man_docs/harbor-registry-create.1 b/doc/man_docs/harbor-registry-create.1 new file mode 100644 index 00000000..ef6b4250 --- /dev/null +++ b/doc/man_docs/harbor-registry-create.1 @@ -0,0 +1,73 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-create - create registry + + +.SH SYNOPSIS +.PP +\fBharbor registry create [flags]\fP + + +.SH DESCRIPTION +.PP +create registry + + +.SH OPTIONS +.PP +\fB--credential-access-key\fP="" + Access key, e.g. user name when credential type is 'basic' + +.PP +\fB--credential-access-secret\fP="" + Access secret, e.g. password when credential type is 'basic' + +.PP +\fB--credential-type\fP="basic" + Credential type, such as 'basic', 'oauth' + +.PP +\fB--description\fP="" + Description of the registry + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + +.PP +\fB--insecure\fP[=true] + Whether or not the certificate will be verified when Harbor tries to access the server + +.PP +\fB--name\fP="" + Name of the registry + +.PP +\fB--type\fP="harbor" + Type of the registry + +.PP +\fB--url\fP="" + Registry endpoint URL + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-registry-delete.1 b/doc/man_docs/harbor-registry-delete.1 new file mode 100644 index 00000000..1b6e2a86 --- /dev/null +++ b/doc/man_docs/harbor-registry-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-delete - delete registry by id + + +.SH SYNOPSIS +.PP +\fBharbor registry delete [flags]\fP + + +.SH DESCRIPTION +.PP +delete registry by id + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for delete + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-registry-info.1 b/doc/man_docs/harbor-registry-info.1 new file mode 100644 index 00000000..69ef357a --- /dev/null +++ b/doc/man_docs/harbor-registry-info.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-info - get registry info + + +.SH SYNOPSIS +.PP +\fBharbor registry info [flags]\fP + + +.SH DESCRIPTION +.PP +get registry info + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for info + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-registry-list.1 b/doc/man_docs/harbor-registry-list.1 new file mode 100644 index 00000000..696c4c90 --- /dev/null +++ b/doc/man_docs/harbor-registry-list.1 @@ -0,0 +1,57 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-list - list registry + + +.SH SYNOPSIS +.PP +\fBharbor registry list [flags]\fP + + +.SH DESCRIPTION +.PP +list registry + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=10 + Size of per page + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-registry-update.1 b/doc/man_docs/harbor-registry-update.1 new file mode 100644 index 00000000..ef56aa43 --- /dev/null +++ b/doc/man_docs/harbor-registry-update.1 @@ -0,0 +1,73 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-update - update registry + + +.SH SYNOPSIS +.PP +\fBharbor registry update [flags]\fP + + +.SH DESCRIPTION +.PP +update registry + + +.SH OPTIONS +.PP +\fB--credential-access-key\fP="" + Access key, e.g. user name when credential type is 'basic' + +.PP +\fB--credential-access-secret\fP="" + Access secret, e.g. password when credential type is 'basic' + +.PP +\fB--credential-type\fP="" + Credential type, such as 'basic', 'oauth' + +.PP +\fB--description\fP="" + Description of the registry + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for update + +.PP +\fB--insecure\fP[=true] + Whether or not the certificate will be verified when Harbor tries to access the server + +.PP +\fB--name\fP="" + Name of the registry + +.PP +\fB--type\fP="" + Type of the registry + +.PP +\fB--url\fP="" + Registry endpoint URL + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-registry-view.1 b/doc/man_docs/harbor-registry-view.1 new file mode 100644 index 00000000..ee94b57b --- /dev/null +++ b/doc/man_docs/harbor-registry-view.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-view - get registry by id + + +.SH SYNOPSIS +.PP +\fBharbor registry view [flags]\fP + + +.SH DESCRIPTION +.PP +get registry by id + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for view + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-registry.1 b/doc/man_docs/harbor-registry.1 new file mode 100644 index 00000000..2675b79c --- /dev/null +++ b/doc/man_docs/harbor-registry.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry - Manage registries + + +.SH SYNOPSIS +.PP +\fBharbor registry [flags]\fP + + +.SH DESCRIPTION +.PP +Manage registries in Harbor + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for registry + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor registry list +.EE + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP, \fBharbor-registry-create(1)\fP, \fBharbor-registry-delete(1)\fP, \fBharbor-registry-info(1)\fP, \fBharbor-registry-list(1)\fP, \fBharbor-registry-update(1)\fP, \fBharbor-registry-view(1)\fP diff --git a/doc/man_docs/harbor-repo-delete.1 b/doc/man_docs/harbor-repo-delete.1 new file mode 100644 index 00000000..8ed1eeba --- /dev/null +++ b/doc/man_docs/harbor-repo-delete.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-repo-delete - Delete a repository + + +.SH SYNOPSIS +.PP +\fBharbor repo delete [flags]\fP + + +.SH DESCRIPTION +.PP +Delete a repository within a project in Harbor + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for delete + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor repository delete [project_name]/[repository_name] +.EE + + +.SH SEE ALSO +.PP +\fBharbor-repo(1)\fP diff --git a/doc/man_docs/harbor-repo-info.1 b/doc/man_docs/harbor-repo-info.1 new file mode 100644 index 00000000..a6dba505 --- /dev/null +++ b/doc/man_docs/harbor-repo-info.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-repo-info - Get repository information + + +.SH SYNOPSIS +.PP +\fBharbor repo info [flags]\fP + + +.SH DESCRIPTION +.PP +Get information of a particular repository in a project + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for info + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor repo info / +.EE + + +.SH SEE ALSO +.PP +\fBharbor-repo(1)\fP diff --git a/doc/man_docs/harbor-repo-list.1 b/doc/man_docs/harbor-repo-list.1 new file mode 100644 index 00000000..c1d12ee3 --- /dev/null +++ b/doc/man_docs/harbor-repo-list.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-repo-list - list repositories within a project + + +.SH SYNOPSIS +.PP +\fBharbor repo list [flags]\fP + + +.SH DESCRIPTION +.PP +list repositories within a project + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for list + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-repo(1)\fP diff --git a/doc/man_docs/harbor-repo.1 b/doc/man_docs/harbor-repo.1 new file mode 100644 index 00000000..6f561d0c --- /dev/null +++ b/doc/man_docs/harbor-repo.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-repo - Manage repositories + + +.SH SYNOPSIS +.PP +\fBharbor repo [flags]\fP + + +.SH DESCRIPTION +.PP +Manage repositories in Harbor context + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for repo + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP, \fBharbor-repo-delete(1)\fP, \fBharbor-repo-info(1)\fP, \fBharbor-repo-list(1)\fP diff --git a/doc/man_docs/harbor-user-create.1 b/doc/man_docs/harbor-user-create.1 new file mode 100644 index 00000000..9934fbd7 --- /dev/null +++ b/doc/man_docs/harbor-user-create.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-user-create - create user + + +.SH SYNOPSIS +.PP +\fBharbor user create [flags]\fP + + +.SH DESCRIPTION +.PP +create user + + +.SH OPTIONS +.PP +\fB--comment\fP="" + Comment + +.PP +\fB--email\fP="" + Email + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + +.PP +\fB--password\fP="" + Password + +.PP +\fB--realname\fP="" + Realname + +.PP +\fB--username\fP="" + Username + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-user(1)\fP diff --git a/doc/man_docs/harbor-user-delete.1 b/doc/man_docs/harbor-user-delete.1 new file mode 100644 index 00000000..372ae297 --- /dev/null +++ b/doc/man_docs/harbor-user-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-user-delete - delete user + + +.SH SYNOPSIS +.PP +\fBharbor user delete [flags]\fP + + +.SH DESCRIPTION +.PP +delete user + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for delete + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-user(1)\fP diff --git a/doc/man_docs/harbor-user-elevate.1 b/doc/man_docs/harbor-user-elevate.1 new file mode 100644 index 00000000..3bc57ac4 --- /dev/null +++ b/doc/man_docs/harbor-user-elevate.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-user-elevate - elevate user + + +.SH SYNOPSIS +.PP +\fBharbor user elevate [flags]\fP + + +.SH DESCRIPTION +.PP +elevate user to admin role + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for elevate + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-user(1)\fP diff --git a/doc/man_docs/harbor-user-list.1 b/doc/man_docs/harbor-user-list.1 new file mode 100644 index 00000000..e3f4cdaa --- /dev/null +++ b/doc/man_docs/harbor-user-list.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-user-list - list users + + +.SH SYNOPSIS +.PP +\fBharbor user list [flags]\fP + + +.SH DESCRIPTION +.PP +list users + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for list + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +.PP +\fBharbor-user(1)\fP diff --git a/doc/man_docs/harbor-user.1 b/doc/man_docs/harbor-user.1 new file mode 100644 index 00000000..bde84e51 --- /dev/null +++ b/doc/man_docs/harbor-user.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-user - Manage users + + +.SH SYNOPSIS +.PP +\fBharbor user [flags]\fP + + +.SH DESCRIPTION +.PP +Manage users in Harbor + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for user + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor user list +.EE + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP, \fBharbor-user-create(1)\fP, \fBharbor-user-delete(1)\fP, \fBharbor-user-elevate(1)\fP, \fBharbor-user-list(1)\fP diff --git a/doc/man_docs/harbor-version.1 b/doc/man_docs/harbor-version.1 new file mode 100644 index 00000000..90d60b02 --- /dev/null +++ b/doc/man_docs/harbor-version.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-version - Version of Harbor CLI + + +.SH SYNOPSIS +.PP +\fBharbor version [flags]\fP + + +.SH DESCRIPTION +.PP +Get Harbor CLI version, git commit, go version, build time, release channel, os/arch, etc. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for version + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + harbor version +.EE + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP diff --git a/doc/man_docs/harbor.1 b/doc/man_docs/harbor.1 new file mode 100644 index 00000000..fa20a67c --- /dev/null +++ b/doc/man_docs/harbor.1 @@ -0,0 +1,51 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor - Official Harbor CLI + + +.SH SYNOPSIS +.PP +\fBharbor [flags]\fP + + +.SH DESCRIPTION +.PP +Official Harbor CLI + + +.SH OPTIONS +.PP +\fB--config\fP="/home/bupd/.harbor/config.yaml" + config file (default is $HOME/.harbor/config.yaml) + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for harbor + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + +// Base command: +harbor + +// Display help about the command: +harbor help + +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact(1)\fP, \fBharbor-login(1)\fP, \fBharbor-project(1)\fP, \fBharbor-registry(1)\fP, \fBharbor-repo(1)\fP, \fBharbor-user(1)\fP, \fBharbor-version(1)\fP diff --git a/doc/md_doc.go b/doc/md_doc.go deleted file mode 100644 index f5e3f6b7..00000000 --- a/doc/md_doc.go +++ /dev/null @@ -1,33 +0,0 @@ -package main - -import ( - "fmt" - "os" - - cmd "github.com/goharbor/harbor-cli/cmd/harbor/root" - "github.com/spf13/cobra/doc" -) - -func main() { - // create temporary dir in currentDir for documents. - // Assuming you are executing from the main directory. - currentDir, err := os.Getwd() - if err != nil { - fmt.Println(err) - } - docDir := fmt.Sprintf("%s/%s", currentDir, "doc/md_docs/") - os.RemoveAll(docDir) - err = os.MkdirAll(docDir, os.ModePerm) - if err != nil { - fmt.Println("Error creating docs directory:", err) - os.Exit(1) - } - - err = doc.GenMarkdownTree(cmd.RootCmd(), docDir) - if err != nil { - fmt.Println("Error generating documentation:", err) - os.Exit(1) - } - - fmt.Println("Documentation generated successfully in", docDir) -} diff --git a/go.mod b/go.mod index 5d61eb80..27f2426d 100644 --- a/go.mod +++ b/go.mod @@ -40,7 +40,6 @@ require ( github.com/pelletier/go-toml/v2 v2.2.3 // indirect github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect github.com/rivo/uniseg v0.4.7 // indirect - github.com/rogpeppe/go-internal v1.13.1 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/sagikazarmark/locafero v0.6.0 // indirect github.com/sagikazarmark/slog-shim v0.1.0 // indirect diff --git a/go.sum b/go.sum index 18316416..d4cdf383 100644 --- a/go.sum +++ b/go.sum @@ -12,31 +12,20 @@ github.com/catppuccin/go v0.2.0 h1:ktBeIrIP42b/8FGiScP9sgrWOss3lw0Z5SktRoithGA= github.com/catppuccin/go v0.2.0/go.mod h1:8IHJuMGaUUjQM82qBrGNBv7LFq6JI3NnQCF6MOlZjpc= github.com/charmbracelet/bubbles v0.20.0 h1:jSZu6qD8cRQ6k9OMfR1WlM+ruM8fkPWkHvQWD9LIutE= github.com/charmbracelet/bubbles v0.20.0/go.mod h1:39slydyswPy+uVOHZ5x/GjwVAFkCsV8IIVy+4MhzwwU= -github.com/charmbracelet/bubbletea v1.1.0 h1:FjAl9eAL3HBCHenhz/ZPjkKdScmaS5SK69JAK2YJK9c= -github.com/charmbracelet/bubbletea v1.1.0/go.mod h1:9Ogk0HrdbHolIKHdjfFpyXJmiCzGwy+FesYkZr7hYU4= github.com/charmbracelet/bubbletea v1.2.4 h1:KN8aCViA0eps9SCOThb2/XPIlea3ANJLUkv3KnQRNCE= github.com/charmbracelet/bubbletea v1.2.4/go.mod h1:Qr6fVQw+wX7JkWWkVyXYk/ZUQ92a6XNekLXa3rR18MM= github.com/charmbracelet/huh v0.6.0 h1:mZM8VvZGuE0hoDXq6XLxRtgfWyTI3b2jZNKh0xWmax8= github.com/charmbracelet/huh v0.6.0/go.mod h1:GGNKeWCeNzKpEOh/OJD8WBwTQjV3prFAtQPpLv+AVwU= -github.com/charmbracelet/lipgloss v0.13.0 h1:4X3PPeoWEDCMvzDvGmTajSyYPcZM4+y8sCA/SsA3cjw= -github.com/charmbracelet/lipgloss v0.13.0/go.mod h1:nw4zy0SBX/F/eAO1cWdcvy6qnkDUxr8Lw7dvFrAIbbY= github.com/charmbracelet/lipgloss v1.0.0 h1:O7VkGDvqEdGi93X+DeqsQ7PKHDgtQfF8j8/O2qFMQNg= github.com/charmbracelet/lipgloss v1.0.0/go.mod h1:U5fy9Z+C38obMs+T+tJqst9VGzlOYGj4ri9reL3qUlo= -github.com/charmbracelet/x/ansi v0.2.3 h1:VfFN0NUpcjBRd4DnKfRaIRo53KRgey/nhOoEqosGDEY= -github.com/charmbracelet/x/ansi v0.2.3/go.mod h1:dk73KoMTT5AX5BsX0KrqhsTqAnhZZoCBjs7dGWp4Ktw= github.com/charmbracelet/x/ansi v0.6.0 h1:qOznutrb93gx9oMiGf7caF7bqqubh6YIM0SWKyA08pA= github.com/charmbracelet/x/ansi v0.6.0/go.mod h1:KBUFw1la39nl0dLl10l5ORDAqGXaeurTQmwyyVKse/Q= github.com/charmbracelet/x/exp/golden v0.0.0-20240815200342-61de596daa2b h1:MnAMdlwSltxJyULnrYbkZpp4k58Co7Tah3ciKhSNo0Q= github.com/charmbracelet/x/exp/golden v0.0.0-20240815200342-61de596daa2b/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U= -github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 h1:qko3AQ4gK1MTS/de7F5hPGx6/k1u0w4TeYmBFwzYVP4= -github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ= github.com/charmbracelet/x/exp/strings v0.0.0-20241222104055-e1130b311607 h1:D5Di9oyZpU7yeL2wkc5E4VaCXyg+8QYYN4kxMsLufDs= github.com/charmbracelet/x/exp/strings v0.0.0-20241222104055-e1130b311607/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ= -github.com/charmbracelet/x/term v0.2.0 h1:cNB9Ot9q8I711MyZ7myUR5HFWL/lc3OpU8jZ4hwm0x0= -github.com/charmbracelet/x/term v0.2.0/go.mod h1:GVxgxAbjUrmpvIINHIQnJJKpMlHiZ4cktEQCN6GWyF0= github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ= github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg= -github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4= github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/cpuguy83/go-md2man/v2 v2.0.6 h1:XJtiaUW6dEEqVuZiMTn1ldk455QWwEIsMIJlo5vtkx0= github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= @@ -50,8 +39,6 @@ github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6 github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM= github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8= github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0= -github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA= -github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM= github.com/fsnotify/fsnotify v1.8.0 h1:dAwr6QBTBZIkG8roQaJjGof0pp0EeF+tNV7YBP3F/8M= github.com/fsnotify/fsnotify v1.8.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= @@ -99,12 +86,8 @@ github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= -github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY= -github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0= github.com/magiconair/properties v1.8.9 h1:nWcCbLq1N2v/cpNsy5WvQ37Fb+YElfq20WJ/a8RkpQM= github.com/magiconair/properties v1.8.9/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0= -github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0= -github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= github.com/mailru/easyjson v0.9.0 h1:PrnmzHw7262yW8sTBwxi1PdJA3Iw/EKBa8psRf7d9a4= github.com/mailru/easyjson v0.9.0/go.mod h1:1+xMtQp2MRNVL/V1bOzuP3aP8VNwRW55fQUto+XFtTU= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= @@ -127,8 +110,6 @@ github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4= github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= github.com/opentracing/opentracing-go v1.2.0 h1:uEJPy/1a5RIPAJ0Ov+OIO8OxWu77jEv+1B0VhjKrZUs= github.com/opentracing/opentracing-go v1.2.0/go.mod h1:GxEUsuufX4nBwe+T+Wl9TAgYrxe9dPLANfrWvHYVTgc= -github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM= -github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs= github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M= github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= @@ -137,8 +118,7 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= -github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8= -github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4= +github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII= github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= @@ -154,8 +134,6 @@ github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9yS github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0= github.com/spf13/afero v1.11.0 h1:WJQKhtpdm3v2IzqG8VMqrr6Rf3UYpEF239Jy9wNepM8= github.com/spf13/afero v1.11.0/go.mod h1:GH9Y3pIexgf1MTIWtNGyogA5MwRIDXGUr+hbWNoBjkY= -github.com/spf13/cast v1.6.0 h1:GEiTHELF+vaR5dhz3VqZfFSzZjYbgeKDpBxQVS4GYJ0= -github.com/spf13/cast v1.6.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo= github.com/spf13/cast v1.7.1 h1:cuNEagBQEHWN1FnbGEjCXL2szYEXqfJPbP2HNUaca9Y= github.com/spf13/cast v1.7.1/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo= github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM= @@ -165,62 +143,37 @@ github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An github.com/spf13/viper v1.19.0 h1:RWq5SEjt8o25SROyN3z2OrDB9l7RPd3lwTWU8EcEdcI= github.com/spf13/viper v1.19.0/go.mod h1:GQUN9bilAbhU/jgc1bKs99f/suXKeUMct8Adx5+Ntkg= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= -github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= -github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= -github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= -github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8= github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU= -go.mongodb.org/mongo-driver v1.16.0 h1:tpRsfBJMROVHKpdGyc1BBEzzjDUWjItxbVSZ8Ls4BQ4= -go.mongodb.org/mongo-driver v1.16.0/go.mod h1:oB6AhJQvFQL4LEHyXi6aJzQJtBiTQHiAd83l0GdFaiw= go.mongodb.org/mongo-driver v1.17.1 h1:Wic5cJIwJgSpBhe3lx3+/RybR5PiYRMpVFgO7cOHyIM= go.mongodb.org/mongo-driver v1.17.1/go.mod h1:wwWm/+BuOddhcq3n68LKRmgk2wXzmF6s0SFOa0GINL4= go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= -go.opentelemetry.io/otel v1.31.0 h1:NsJcKPIW0D0H3NgzPDHmo0WW6SptzPdqg/L1zsIm2hY= -go.opentelemetry.io/otel v1.31.0/go.mod h1:O0C14Yl9FgkjqcCZAsE053C13OaddMYr/hz6clDkEJE= go.opentelemetry.io/otel v1.33.0 h1:/FerN9bax5LoK51X/sI0SVYrjSE0/yUL7DpxW4K3FWw= go.opentelemetry.io/otel v1.33.0/go.mod h1:SUUkR6csvUQl+yjReHu5uM3EtVV7MBm5FHKRlNx4I8I= -go.opentelemetry.io/otel/metric v1.31.0 h1:FSErL0ATQAmYHUIzSezZibnyVlft1ybhy4ozRPcF2fE= -go.opentelemetry.io/otel/metric v1.31.0/go.mod h1:C3dEloVbLuYoX41KpmAhOqNriGbA+qqH6PQ5E5mUfnY= go.opentelemetry.io/otel/metric v1.33.0 h1:r+JOocAyeRVXD8lZpjdQjzMadVZp2M4WmQ+5WtEnklQ= go.opentelemetry.io/otel/metric v1.33.0/go.mod h1:L9+Fyctbp6HFTddIxClbQkjtubW6O9QS3Ann/M82u6M= go.opentelemetry.io/otel/sdk v1.28.0 h1:b9d7hIry8yZsgtbmM0DKyPWMMUMlK9NEKuIG4aBqWyE= go.opentelemetry.io/otel/sdk v1.28.0/go.mod h1:oYj7ClPUA7Iw3m+r7GeEjz0qckQRJK2B8zjcZEfu7Pg= -go.opentelemetry.io/otel/trace v1.31.0 h1:ffjsj1aRouKewfr85U2aGagJ46+MvodynlQ1HYdmJys= -go.opentelemetry.io/otel/trace v1.31.0/go.mod h1:TXZkRk7SM2ZQLtR6eoAWQFIHPvzQ06FJAsO1tJg480A= go.opentelemetry.io/otel/trace v1.33.0 h1:cCJuF7LRjUFso9LPnEAHJDB2pqzp+hbO8eu1qqW2d/s= go.opentelemetry.io/otel/trace v1.33.0/go.mod h1:uIcdVUZMpTAmz0tI1z04GoVSezK37CbGV4fr1f2nBck= go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= -golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 h1:2dVuKD2vS7b0QIHQbpyTISPd0LeHDbnYEryqj5Q1ug8= -golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56/go.mod h1:M4RDyNAINzryxdtnbRXRL/OHtkFuWGRjvuhBJpk2IlY= golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67 h1:1UoZQm6f0P/ZO0w1Ri+f+ifG/gXhegadRdwBIXEFWDo= golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67/go.mod h1:qj5a5QZpwLU2NLQudwIN5koi3beDhSAlJwa67PuM98c= -golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ= -golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ= golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34= -golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/term v0.6.0 h1:clScbb1cHjoCkyRbWwBEUZ5H/tIFu5TAXIqaZD0Gcjw= -golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= golang.org/x/term v0.27.0 h1:WP60Sv1nlK1T6SupCHbXzSaN0b9wUmsPoRS9b61A23Q= golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= -golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224= -golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY= golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo= golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= From 0177b9f6f1160a4626c6c9ec6fe9f3a1756b6311 Mon Sep 17 00:00:00 2001 From: bupd Date: Sat, 28 Dec 2024 09:10:26 +0530 Subject: [PATCH 3/8] update dagger for generating man pages Signed-off-by: bupd --- cmd/harbor/root/registry/update.go | 2 +- dagger/main.go | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/cmd/harbor/root/registry/update.go b/cmd/harbor/root/registry/update.go index 84b17aec..5bff569b 100644 --- a/cmd/harbor/root/registry/update.go +++ b/cmd/harbor/root/registry/update.go @@ -94,7 +94,7 @@ func UpdateRegistryCommand() *cobra.Command { flags.BoolVarP(&opts.Insecure, "insecure", "i", false, "Whether or not the certificate will be verified when Harbor tries to access the server") flags.StringVarP(&opts.Credential.AccessKey, "credential-access-key", "k", "", "Access key, e.g. user name when credential type is 'basic'") flags.StringVarP(&opts.Credential.AccessSecret, "credential-access-secret", "s", "", "Access secret, e.g. password when credential type is 'basic'") - flags.StringVarP(&opts.Credential.Type, "credential-type", "c", "", "Credential type, such as 'basic', 'oauth'") + flags.StringVarP(&opts.Credential.Type, "credential-type", "", "", "Credential type, such as 'basic', 'oauth'") return cmd } diff --git a/dagger/main.go b/dagger/main.go index 1035123f..3e128962 100644 --- a/dagger/main.go +++ b/dagger/main.go @@ -34,11 +34,9 @@ func (m *HarborCli) BuildDev( ctx context.Context, platform string, ) *dagger.File { - fmt.Println("🛠️ Building Harbor-Cli with Dagger...") // Define the path for the binary output os, arch, err := parsePlatform(platform) - if err != nil { log.Fatalf("Error parsing platform: %v", err) } @@ -97,9 +95,11 @@ func (m *HarborCli) build( // LintReport Executes the Linter and writes the linting results to a file golangci-lint-report.sarif func (m *HarborCli) LintReport(ctx context.Context) *dagger.File { report := "golangci-lint-report.sarif" - return m.lint(ctx).WithExec([]string{"golangci-lint", "run", + return m.lint(ctx).WithExec([]string{ + "golangci-lint", "run", "--out-format", "sarif:" + report, - "--issues-exit-code", "0"}).File(report) + "--issues-exit-code", "0", + }).File(report) } // Lint Run the linter golangci-lint @@ -125,7 +125,8 @@ func (m *HarborCli) PublishImage( // +optional // +default=["latest"] imageTags []string, - registryPassword *dagger.Secret) []string { + registryPassword *dagger.Secret, +) []string { builders := m.build(ctx) releaseImages := []*dagger.Container{} @@ -159,7 +160,6 @@ func (m *HarborCli) PublishImage( fmt.Sprintf("%s/%s/harbor-cli:%s", registry, "harbor-cli", imageTag), dagger.ContainerPublishOpts{PlatformVariants: releaseImages}, ) - if err != nil { panic(err) } @@ -207,10 +207,9 @@ func (m *HarborCli) goreleaserContainer() *dagger.Container { WithMountedDirectory("/src", m.Source). WithWorkdir("/src"). WithEnvVariable("TINI_SUBREAPER", "true") - } -// RunDoc Generate CLI Documentation with doc.go and return the directory containing the generated files +// Generate CLI Documentation and return the directory containing the generated files func (m *HarborCli) RunDoc(ctx context.Context) *dagger.Directory { return dag.Container(). From("golang:"+GO_VERSION+"-alpine"). @@ -221,6 +220,7 @@ func (m *HarborCli) RunDoc(ctx context.Context) *dagger.Directory { WithMountedDirectory("/src", m.Source). WithWorkdir("/src/doc"). WithExec([]string{"go", "run", "doc.go"}). + WithExec([]string{"go", "run", "man_doc.go"}). WithWorkdir("/src").Directory("/src/doc") } @@ -261,7 +261,6 @@ func (m *HarborCli) PublishImageAndSign( // +optional actionsIdTokenRequestUrl string, ) (string, error) { - imageAddrs := m.PublishImage(ctx, registry, registryUsername, imageTags, registryPassword) _, err := m.Sign( ctx, @@ -309,7 +308,8 @@ func (m *HarborCli) Sign(ctx context.Context, return cosing_ctr.WithSecretVariable("REGISTRY_PASSWORD", registryPassword). WithExec([]string{"cosign", "env"}). - WithExec([]string{"cosign", "sign", "--yes", "--recursive", + WithExec([]string{ + "cosign", "sign", "--yes", "--recursive", "--registry-username", registryUsername, "--registry-password", registryPasswordPlain, imageAddr, From 1a8d10e5691cab791bb30c3533c04aa1d8d2d5fd Mon Sep 17 00:00:00 2001 From: bupd Date: Sat, 28 Dec 2024 09:10:55 +0530 Subject: [PATCH 4/8] update github workflow Signed-off-by: bupd --- .github/workflows/default.yaml | 127 +++++++++++++++++++-------------- dagger.json | 4 +- 2 files changed, 75 insertions(+), 56 deletions(-) diff --git a/.github/workflows/default.yaml b/.github/workflows/default.yaml index 7138e444..55cc1d12 100644 --- a/.github/workflows/default.yaml +++ b/.github/workflows/default.yaml @@ -7,8 +7,8 @@ on: - "v*.*.*" pull_request: paths-ignore: - - '*.md' - - 'assets/**' + - "*.md" + - "assets/**" jobs: lint: @@ -22,6 +22,19 @@ jobs: - name: Dagger Version uses: sagikazarmark/dagger-version-action@v0.0.1 + - name: Generate Documentation + uses: dagger/dagger-for-github@v7 + with: + version: ${{ steps.dagger_version.outputs.version }} + verb: call + args: run-doc export --path=doc + + - name: Check for changes + run: | + # Check if any files were changed by document + git diff --exit-code + continue-on-error: false + - name: Run Dagger golangci-lint uses: dagger/dagger-for-github@v7 with: @@ -59,61 +72,67 @@ jobs: args: build-dev --platform linux/amd64 export --path=./harbor-dev push-latest-images: - if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) - needs: - - lint - - test-code - permissions: - contents: read - id-token: write - runs-on: ubuntu-latest - steps: - - name: Checkout repo - uses: actions/checkout@v4 - with: - fetch-depth: 0 + - name: Print GitHub ref for debugging + run: echo "GitHub ref: $GITHUB_REF" - - name: Publish and Sign Snapshot Image - uses: ./.github/actions/publish-and-sign - with: - IMAGE_TAGS: latest - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} - REGISTRY_ADDRESS: ${{ vars.REGISTRY_ADDRESS }} - REGISTRY_USERNAME: ${{ vars.REGISTRY_USERNAME }} + - name: Push images + if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) + needs: + - lint + - test-code + permissions: + contents: read + id-token: write + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Publish and Sign Snapshot Image + uses: ./.github/actions/publish-and-sign + with: + IMAGE_TAGS: latest + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} + REGISTRY_ADDRESS: ${{ vars.REGISTRY_ADDRESS }} + REGISTRY_USERNAME: ${{ vars.REGISTRY_USERNAME }} publish-release: - if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) - needs: - - lint - - test-code - permissions: - contents: write - packages: write - id-token: write - runs-on: ubuntu-latest - steps: - - name: Checkout repo - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Create Release - uses: dagger/dagger-for-github@v7 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - version: "latest" - verb: call - args: "release --github-token=env:GITHUB_TOKEN" + - name: Print GitHub ref for debugging + run: echo "GitHub ref: $GITHUB_REF" - - name: Publish and Sign Tagged Image - if: success() - uses: ./.github/actions/publish-and-sign - with: - IMAGE_TAGS: "latest, ${{ github.ref_name }}" - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} - REGISTRY_ADDRESS: ${{ vars.REGISTRY_ADDRESS }} - REGISTRY_USERNAME: ${{ vars.REGISTRY_USERNAME }} + - name: Push images + if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) + needs: + - lint + - test-code + permissions: + contents: write + packages: write + id-token: write + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Create Release + uses: dagger/dagger-for-github@v7 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + version: "latest" + verb: call + args: "release --github-token=env:GITHUB_TOKEN" + - name: Publish and Sign Tagged Image + if: success() + uses: ./.github/actions/publish-and-sign + with: + IMAGE_TAGS: "latest, ${{ github.ref_name }}" + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} + REGISTRY_ADDRESS: ${{ vars.REGISTRY_ADDRESS }} + REGISTRY_USERNAME: ${{ vars.REGISTRY_USERNAME }} diff --git a/dagger.json b/dagger.json index fa623ae3..49096066 100644 --- a/dagger.json +++ b/dagger.json @@ -1,5 +1,6 @@ { "name": "harbor-cli", + "engineVersion": "v0.14.0", "sdk": "go", "dependencies": [ { @@ -8,6 +9,5 @@ "pin": "8359122a7b90f2c8c6f3165570fdcbec6e923023" } ], - "source": "dagger", - "engineVersion": "v0.14.0" + "source": "dagger" } From ed0a42ec905dee0d78c047fe814078bc226e28f6 Mon Sep 17 00:00:00 2001 From: bupd Date: Sat, 28 Dec 2024 09:11:05 +0530 Subject: [PATCH 5/8] update man doc generation Signed-off-by: bupd --- doc/man_doc.go | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/doc/man_doc.go b/doc/man_doc.go index 60f894bb..228c439d 100644 --- a/doc/man_doc.go +++ b/doc/man_doc.go @@ -6,23 +6,24 @@ import ( "time" cmd "github.com/goharbor/harbor-cli/cmd/harbor/root" + log "github.com/sirupsen/logrus" "github.com/spf13/cobra/doc" ) -func main() { - // create temporary dir in currentDir for documents. - // Assuming you are executing from the main directory. +func ManDoc() error { currentDir, err := os.Getwd() if err != nil { - fmt.Println(err) + return err } - docDir := fmt.Sprintf("%s/%s", currentDir, "doc/man_docs/") - os.RemoveAll(docDir) - err = os.MkdirAll(docDir, os.ModePerm) - if err != nil { - fmt.Println("Error creating docs directory:", err) - os.Exit(1) + folderName := "man-docs" + _, err = os.Stat(folderName) + if os.IsNotExist(err) { + err = os.Mkdir(folderName, 0755) + if err != nil { + log.Fatal("Error creating folder:", err) + } } + docDir := fmt.Sprintf("%s/%s", currentDir, folderName) t := time.Now() @@ -41,4 +42,12 @@ func main() { } fmt.Println("Documentation generated successfully in", docDir) + return nil +} + +func main() { + err := ManDoc() + if err != nil { + log.Fatal(err) + } } From 41b25545a9ab72058fdeac8afd234f80f8f6aab5 Mon Sep 17 00:00:00 2001 From: bupd Date: Sat, 28 Dec 2024 09:11:26 +0530 Subject: [PATCH 6/8] add cli and man docs Signed-off-by: bupd --- doc/cli-docs/harbor-artifact-view.md | 42 +++++++++++++ doc/cli-docs/harbor-label-create.md | 46 ++++++++++++++ doc/cli-docs/harbor-label-delete.md | 39 ++++++++++++ doc/cli-docs/harbor-label-list.md | 38 +++++++++++ doc/cli-docs/harbor-label-update.md | 42 +++++++++++++ doc/cli-docs/harbor-label.md | 32 ++++++++++ doc/cli-docs/harbor-project-search.md | 32 ++++++++++ doc/cli-docs/harbor-repo-search.md | 32 ++++++++++ doc/cli-docs/harbor-repo-view.md | 42 +++++++++++++ doc/cli-docs/harbor-schedule-list.md | 34 ++++++++++ doc/cli-docs/harbor-schedule.md | 29 +++++++++ .../harbor-artifact-delete.1 | 16 +++-- .../harbor-artifact-list.1 | 32 +++++++--- .../harbor-artifact-scan-start.1 | 16 +++-- .../harbor-artifact-scan-stop.1 | 16 +++-- .../harbor-artifact-scan.1 | 16 +++-- .../harbor-artifact-tags-create.1 | 16 +++-- .../harbor-artifact-tags-delete.1 | 16 +++-- .../harbor-artifact-tags-list.1 | 16 +++-- .../harbor-artifact-tags.1 | 16 +++-- doc/man-docs/harbor-artifact-view.1 | 45 +++++++++++++ doc/{man_docs => man-docs}/harbor-artifact.1 | 18 +++--- doc/man-docs/harbor-health.1 | 45 +++++++++++++ doc/man-docs/harbor-label-create.1 | 61 ++++++++++++++++++ doc/man-docs/harbor-label-delete.1 | 49 +++++++++++++++ doc/man-docs/harbor-label-list.1 | 63 +++++++++++++++++++ doc/man-docs/harbor-label-update.1 | 61 ++++++++++++++++++ doc/man-docs/harbor-label.1 | 39 ++++++++++++ doc/{man_docs => man-docs}/harbor-login.1 | 20 +++--- .../harbor-project-create.1 | 24 +++---- .../harbor-project-delete.1 | 18 +++--- .../harbor-project-list.1 | 22 ++++--- .../harbor-project-logs.1 | 16 +++-- doc/man-docs/harbor-project-search.1 | 39 ++++++++++++ .../harbor-project-view.1 | 16 +++-- doc/{man_docs => man-docs}/harbor-project.1 | 18 +++--- .../harbor-registry-create.1 | 26 ++++---- .../harbor-registry-delete.1 | 26 ++++---- .../harbor-registry-list.1 | 16 +++-- .../harbor-registry-update.1 | 32 +++++----- .../harbor-registry-view.1 | 26 ++++---- doc/{man_docs => man-docs}/harbor-registry.1 | 18 +++--- .../harbor-repo-delete.1 | 16 +++-- doc/{man_docs => man-docs}/harbor-repo-list.1 | 24 ++++--- doc/man-docs/harbor-repo-search.1 | 39 ++++++++++++ .../harbor-repo-view.1} | 24 ++++--- doc/{man_docs => man-docs}/harbor-repo.1 | 18 +++--- doc/man-docs/harbor-schedule-list.1 | 47 ++++++++++++++ doc/man-docs/harbor-schedule.1 | 39 ++++++++++++ .../harbor-user-create.1 | 16 +++-- .../harbor-user-delete.1 | 16 +++-- .../harbor-user-elevate.1 | 16 +++-- doc/man-docs/harbor-user-list.1 | 55 ++++++++++++++++ doc/{man_docs => man-docs}/harbor-user.1 | 16 +++-- doc/{man_docs => man-docs}/harbor-version.1 | 16 +++-- doc/man-docs/harbor.1 | 50 +++++++++++++++ doc/man_docs/harbor-artifact-info.1 | 47 -------------- doc/man_docs/harbor-registry-info.1 | 41 ------------ doc/man_docs/harbor-user-list.1 | 41 ------------ doc/man_docs/harbor.1 | 51 --------------- 60 files changed, 1341 insertions(+), 497 deletions(-) create mode 100644 doc/cli-docs/harbor-artifact-view.md create mode 100644 doc/cli-docs/harbor-label-create.md create mode 100644 doc/cli-docs/harbor-label-delete.md create mode 100644 doc/cli-docs/harbor-label-list.md create mode 100644 doc/cli-docs/harbor-label-update.md create mode 100644 doc/cli-docs/harbor-label.md create mode 100644 doc/cli-docs/harbor-project-search.md create mode 100644 doc/cli-docs/harbor-repo-search.md create mode 100644 doc/cli-docs/harbor-repo-view.md create mode 100644 doc/cli-docs/harbor-schedule-list.md create mode 100644 doc/cli-docs/harbor-schedule.md rename doc/{man_docs => man-docs}/harbor-artifact-delete.1 (66%) rename doc/{man_docs => man-docs}/harbor-artifact-list.1 (51%) rename doc/{man_docs => man-docs}/harbor-artifact-scan-start.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-scan-stop.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-scan.1 (73%) rename doc/{man_docs => man-docs}/harbor-artifact-tags-create.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-tags-delete.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-tags-list.1 (71%) rename doc/{man_docs => man-docs}/harbor-artifact-tags.1 (75%) create mode 100644 doc/man-docs/harbor-artifact-view.1 rename doc/{man_docs => man-docs}/harbor-artifact.1 (61%) create mode 100644 doc/man-docs/harbor-health.1 create mode 100644 doc/man-docs/harbor-label-create.1 create mode 100644 doc/man-docs/harbor-label-delete.1 create mode 100644 doc/man-docs/harbor-label-list.1 create mode 100644 doc/man-docs/harbor-label-update.1 create mode 100644 doc/man-docs/harbor-label.1 rename doc/{man_docs => man-docs}/harbor-login.1 (67%) rename doc/{man_docs => man-docs}/harbor-project-create.1 (67%) rename doc/{man_docs => man-docs}/harbor-project-delete.1 (60%) rename doc/{man_docs => man-docs}/harbor-project-list.1 (70%) rename doc/{man_docs => man-docs}/harbor-project-logs.1 (66%) create mode 100644 doc/man-docs/harbor-project-search.1 rename doc/{man_docs => man-docs}/harbor-project-view.1 (67%) rename doc/{man_docs => man-docs}/harbor-project.1 (67%) rename doc/{man_docs => man-docs}/harbor-registry-create.1 (73%) rename doc/{man_docs => man-docs}/harbor-registry-delete.1 (52%) rename doc/{man_docs => man-docs}/harbor-registry-list.1 (74%) rename doc/{man_docs => man-docs}/harbor-registry-update.1 (61%) rename doc/{man_docs => man-docs}/harbor-registry-view.1 (51%) rename doc/{man_docs => man-docs}/harbor-registry.1 (60%) rename doc/{man_docs => man-docs}/harbor-repo-delete.1 (71%) rename doc/{man_docs => man-docs}/harbor-repo-list.1 (56%) create mode 100644 doc/man-docs/harbor-repo-search.1 rename doc/{man_docs/harbor-repo-info.1 => man-docs/harbor-repo-view.1} (52%) rename doc/{man_docs => man-docs}/harbor-repo.1 (54%) create mode 100644 doc/man-docs/harbor-schedule-list.1 create mode 100644 doc/man-docs/harbor-schedule.1 rename doc/{man_docs => man-docs}/harbor-user-create.1 (72%) rename doc/{man_docs => man-docs}/harbor-user-delete.1 (65%) rename doc/{man_docs => man-docs}/harbor-user-elevate.1 (66%) create mode 100644 doc/man-docs/harbor-user-list.1 rename doc/{man_docs => man-docs}/harbor-user.1 (72%) rename doc/{man_docs => man-docs}/harbor-version.1 (71%) create mode 100644 doc/man-docs/harbor.1 delete mode 100644 doc/man_docs/harbor-artifact-info.1 delete mode 100644 doc/man_docs/harbor-registry-info.1 delete mode 100644 doc/man_docs/harbor-user-list.1 delete mode 100644 doc/man_docs/harbor.1 diff --git a/doc/cli-docs/harbor-artifact-view.md b/doc/cli-docs/harbor-artifact-view.md new file mode 100644 index 00000000..eb19d460 --- /dev/null +++ b/doc/cli-docs/harbor-artifact-view.md @@ -0,0 +1,42 @@ +--- +title: harbor artifact view +weight: 45 +--- +## harbor artifact view + +### Description + +##### Get information of an artifact + +### Synopsis + +Get information of an artifact + +```sh +harbor artifact view [flags] +``` + +### Examples + +```sh +harbor artifact view // +``` + +### Options + +```sh + -h, --help help for view +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor artifact](harbor-artifact.md) - Manage artifacts + diff --git a/doc/cli-docs/harbor-label-create.md b/doc/cli-docs/harbor-label-create.md new file mode 100644 index 00000000..a724c472 --- /dev/null +++ b/doc/cli-docs/harbor-label-create.md @@ -0,0 +1,46 @@ +--- +title: harbor label create +weight: 20 +--- +## harbor label create + +### Description + +##### create label + +### Synopsis + +create label in harbor + +```sh +harbor label create [flags] +``` + +### Examples + +```sh +harbor label create +``` + +### Options + +```sh + --color string Color of the label.color is in hex value (default "#FFFFFF") + -d, --description string Description of the label + -h, --help help for create + -n, --name string Name of the label + -s, --scope string Scope of the label. eg- g(global), p(specific project) (default "g") +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label-delete.md b/doc/cli-docs/harbor-label-delete.md new file mode 100644 index 00000000..ce8ea7d4 --- /dev/null +++ b/doc/cli-docs/harbor-label-delete.md @@ -0,0 +1,39 @@ +--- +title: harbor label delete +weight: 60 +--- +## harbor label delete + +### Description + +##### delete label + +```sh +harbor label delete [flags] +``` + +### Examples + +```sh +harbor label delete [labelname] +``` + +### Options + +```sh + -h, --help help for delete + -s, --scope string default(global).'p' for project labels.Query scope of the label (default "g") +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label-list.md b/doc/cli-docs/harbor-label-list.md new file mode 100644 index 00000000..cdf183ff --- /dev/null +++ b/doc/cli-docs/harbor-label-list.md @@ -0,0 +1,38 @@ +--- +title: harbor label list +weight: 60 +--- +## harbor label list + +### Description + +##### list labels + +```sh +harbor label list [flags] +``` + +### Options + +```sh + -h, --help help for list + --page int Page number (default 1) + --page-size int Size of per page (default 20) + -i, --projectid int project ID when query project labels (default 1) + -q, --query string Query string to query resources + -s, --scope string default(global).'p' for project labels.Query scope of the label (default "g") + --sort string Sort the label list in ascending or descending order +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label-update.md b/doc/cli-docs/harbor-label-update.md new file mode 100644 index 00000000..e2072cfe --- /dev/null +++ b/doc/cli-docs/harbor-label-update.md @@ -0,0 +1,42 @@ +--- +title: harbor label update +weight: 70 +--- +## harbor label update + +### Description + +##### update label + +```sh +harbor label update [flags] +``` + +### Examples + +```sh +harbor label update [labelname] +``` + +### Options + +```sh + --color string Color of the label.color is in hex value + -d, --description string Description of the label + -h, --help help for update + -n, --name string Name of the label + -s, --scope string Scope of the label. eg- g(global), p(specific project) (default "g") +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label.md b/doc/cli-docs/harbor-label.md new file mode 100644 index 00000000..fa8a698b --- /dev/null +++ b/doc/cli-docs/harbor-label.md @@ -0,0 +1,32 @@ +--- +title: harbor label +weight: 70 +--- +## harbor label + +### Description + +##### Manage labels in Harbor + +### Options + +```sh + -h, --help help for label +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor](harbor.md) - Official Harbor CLI +* [harbor label create](harbor-label-create.md) - create label +* [harbor label delete](harbor-label-delete.md) - delete label +* [harbor label list](harbor-label-list.md) - list labels +* [harbor label update](harbor-label-update.md) - update label + diff --git a/doc/cli-docs/harbor-project-search.md b/doc/cli-docs/harbor-project-search.md new file mode 100644 index 00000000..392cbbbd --- /dev/null +++ b/doc/cli-docs/harbor-project-search.md @@ -0,0 +1,32 @@ +--- +title: harbor project search +weight: 15 +--- +## harbor project search + +### Description + +##### search project based on their names + +```sh +harbor project search [flags] +``` + +### Options + +```sh + -h, --help help for search +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor project](harbor-project.md) - Manage projects and assign resources to them + diff --git a/doc/cli-docs/harbor-repo-search.md b/doc/cli-docs/harbor-repo-search.md new file mode 100644 index 00000000..227e6c72 --- /dev/null +++ b/doc/cli-docs/harbor-repo-search.md @@ -0,0 +1,32 @@ +--- +title: harbor repo search +weight: 25 +--- +## harbor repo search + +### Description + +##### search repository based on their names + +```sh +harbor repo search [flags] +``` + +### Options + +```sh + -h, --help help for search +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor repo](harbor-repo.md) - Manage repositories + diff --git a/doc/cli-docs/harbor-repo-view.md b/doc/cli-docs/harbor-repo-view.md new file mode 100644 index 00000000..4bfe3024 --- /dev/null +++ b/doc/cli-docs/harbor-repo-view.md @@ -0,0 +1,42 @@ +--- +title: harbor repo view +weight: 40 +--- +## harbor repo view + +### Description + +##### Get repository information + +### Synopsis + +Get information of a particular repository in a project + +```sh +harbor repo view [flags] +``` + +### Examples + +```sh + harbor repo view / +``` + +### Options + +```sh + -h, --help help for view +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor repo](harbor-repo.md) - Manage repositories + diff --git a/doc/cli-docs/harbor-schedule-list.md b/doc/cli-docs/harbor-schedule-list.md new file mode 100644 index 00000000..603a5a44 --- /dev/null +++ b/doc/cli-docs/harbor-schedule-list.md @@ -0,0 +1,34 @@ +--- +title: harbor schedule list +weight: 20 +--- +## harbor schedule list + +### Description + +##### show all schedule jobs in Harbor + +```sh +harbor schedule list [flags] +``` + +### Options + +```sh + -h, --help help for list + --page int Page number (default 1) + --page-size int Size of per page (default 10) +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor schedule](harbor-schedule.md) - Schedule jobs in Harbor + diff --git a/doc/cli-docs/harbor-schedule.md b/doc/cli-docs/harbor-schedule.md new file mode 100644 index 00000000..ae1241d3 --- /dev/null +++ b/doc/cli-docs/harbor-schedule.md @@ -0,0 +1,29 @@ +--- +title: harbor schedule +weight: 75 +--- +## harbor schedule + +### Description + +##### Schedule jobs in Harbor + +### Options + +```sh + -h, --help help for schedule +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor](harbor.md) - Official Harbor CLI +* [harbor schedule list](harbor-schedule-list.md) - show all schedule jobs in Harbor + diff --git a/doc/man_docs/harbor-artifact-delete.1 b/doc/man-docs/harbor-artifact-delete.1 similarity index 66% rename from doc/man_docs/harbor-artifact-delete.1 rename to doc/man-docs/harbor-artifact-delete.1 index 1db46c26..456da0d3 100644 --- a/doc/man_docs/harbor-artifact-delete.1 +++ b/doc/man-docs/harbor-artifact-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-delete - delete an artifact .SH SYNOPSIS -.PP \fBharbor artifact delete [flags]\fP .SH DESCRIPTION -.PP delete an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ delete an artifact .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-list.1 b/doc/man-docs/harbor-artifact-list.1 similarity index 51% rename from doc/man_docs/harbor-artifact-list.1 rename to doc/man-docs/harbor-artifact-list.1 index 315aad31..67171e05 100644 --- a/doc/man_docs/harbor-artifact-list.1 +++ b/doc/man-docs/harbor-artifact-list.1 @@ -1,31 +1,42 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-list - list artifacts within a repository .SH SYNOPSIS -.PP \fBharbor artifact list [flags]\fP .SH DESCRIPTION -.PP list artifacts within a repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list +.PP +\fB-p\fP, \fB--page\fP=1 + Page number + +.PP +\fB-n\fP, \fB--page-size\fP=10 + Size of per page -.SH OPTIONS INHERITED FROM PARENT COMMANDS .PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB-s\fP, \fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +48,8 @@ list artifacts within a repository .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-scan-start.1 b/doc/man-docs/harbor-artifact-scan-start.1 similarity index 72% rename from doc/man_docs/harbor-artifact-scan-start.1 rename to doc/man-docs/harbor-artifact-scan-start.1 index 453e0c50..db9e4725 100644 --- a/doc/man_docs/harbor-artifact-scan-start.1 +++ b/doc/man-docs/harbor-artifact-scan-start.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-scan-start - Start a scan of an artifact .SH SYNOPSIS -.PP \fBharbor artifact scan start [flags]\fP .SH DESCRIPTION -.PP Start a scan of an artifact in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for start .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact scan start // .SH SEE ALSO -.PP \fBharbor-artifact-scan(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-scan-stop.1 b/doc/man-docs/harbor-artifact-scan-stop.1 similarity index 72% rename from doc/man_docs/harbor-artifact-scan-stop.1 rename to doc/man-docs/harbor-artifact-scan-stop.1 index 1e105f46..2ee7effe 100644 --- a/doc/man_docs/harbor-artifact-scan-stop.1 +++ b/doc/man-docs/harbor-artifact-scan-stop.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-scan-stop - Stop a scan of an artifact .SH SYNOPSIS -.PP \fBharbor artifact scan stop [flags]\fP .SH DESCRIPTION -.PP Stop a scan of an artifact in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for stop .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact scan stop // .SH SEE ALSO -.PP \fBharbor-artifact-scan(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-scan.1 b/doc/man-docs/harbor-artifact-scan.1 similarity index 73% rename from doc/man_docs/harbor-artifact-scan.1 rename to doc/man-docs/harbor-artifact-scan.1 index 4fc13c45..f180388e 100644 --- a/doc/man_docs/harbor-artifact-scan.1 +++ b/doc/man-docs/harbor-artifact-scan.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-scan - Scan an artifact .SH SYNOPSIS -.PP \fBharbor artifact scan [flags]\fP .SH DESCRIPTION -.PP Scan an artifact in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for scan .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact scan start // .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP, \fBharbor-artifact-scan-start(1)\fP, \fBharbor-artifact-scan-stop(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags-create.1 b/doc/man-docs/harbor-artifact-tags-create.1 similarity index 72% rename from doc/man_docs/harbor-artifact-tags-create.1 rename to doc/man-docs/harbor-artifact-tags-create.1 index a2d74c03..dbef583a 100644 --- a/doc/man_docs/harbor-artifact-tags-create.1 +++ b/doc/man-docs/harbor-artifact-tags-create.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags-create - Create a tag of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags create [flags]\fP .SH DESCRIPTION -.PP Create a tag of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for create .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact tags create // .SH SEE ALSO -.PP \fBharbor-artifact-tags(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags-delete.1 b/doc/man-docs/harbor-artifact-tags-delete.1 similarity index 72% rename from doc/man_docs/harbor-artifact-tags-delete.1 rename to doc/man-docs/harbor-artifact-tags-delete.1 index 5227d295..f130c712 100644 --- a/doc/man_docs/harbor-artifact-tags-delete.1 +++ b/doc/man-docs/harbor-artifact-tags-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags-delete - Delete a tag of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags delete [flags]\fP .SH DESCRIPTION -.PP Delete a tag of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact tags delete // .SH SEE ALSO -.PP \fBharbor-artifact-tags(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags-list.1 b/doc/man-docs/harbor-artifact-tags-list.1 similarity index 71% rename from doc/man_docs/harbor-artifact-tags-list.1 rename to doc/man-docs/harbor-artifact-tags-list.1 index 4d07a853..f0f5d9bc 100644 --- a/doc/man_docs/harbor-artifact-tags-list.1 +++ b/doc/man-docs/harbor-artifact-tags-list.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags-list - List tags of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags list [flags]\fP .SH DESCRIPTION -.PP List tags of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact tags list // .SH SEE ALSO -.PP \fBharbor-artifact-tags(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags.1 b/doc/man-docs/harbor-artifact-tags.1 similarity index 75% rename from doc/man_docs/harbor-artifact-tags.1 rename to doc/man-docs/harbor-artifact-tags.1 index 3ddf8bba..862010d8 100644 --- a/doc/man_docs/harbor-artifact-tags.1 +++ b/doc/man-docs/harbor-artifact-tags.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags - Manage tags of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags [flags]\fP .SH DESCRIPTION -.PP Manage tags of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for tags .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage tags of an artifact .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP, \fBharbor-artifact-tags-create(1)\fP, \fBharbor-artifact-tags-delete(1)\fP, \fBharbor-artifact-tags-list(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-artifact-view.1 b/doc/man-docs/harbor-artifact-view.1 new file mode 100644 index 00000000..690b50ee --- /dev/null +++ b/doc/man-docs/harbor-artifact-view.1 @@ -0,0 +1,45 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-artifact-view - Get information of an artifact + + +.SH SYNOPSIS +\fBharbor artifact view [flags]\fP + + +.SH DESCRIPTION +Get information of an artifact + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for view + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact view // +.EE + + +.SH SEE ALSO +\fBharbor-artifact(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact.1 b/doc/man-docs/harbor-artifact.1 similarity index 61% rename from doc/man_docs/harbor-artifact.1 rename to doc/man-docs/harbor-artifact.1 index 55ac01d3..488d53de 100644 --- a/doc/man_docs/harbor-artifact.1 +++ b/doc/man-docs/harbor-artifact.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact - Manage artifacts .SH SYNOPSIS -.PP \fBharbor artifact [flags]\fP .SH DESCRIPTION -.PP Manage artifacts in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for artifact .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage artifacts in Harbor Repository .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-artifact-delete(1)\fP, \fBharbor-artifact-info(1)\fP, \fBharbor-artifact-list(1)\fP, \fBharbor-artifact-scan(1)\fP, \fBharbor-artifact-tags(1)\fP +\fBharbor(1)\fP, \fBharbor-artifact-delete(1)\fP, \fBharbor-artifact-list(1)\fP, \fBharbor-artifact-scan(1)\fP, \fBharbor-artifact-tags(1)\fP, \fBharbor-artifact-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-health.1 b/doc/man-docs/harbor-health.1 new file mode 100644 index 00000000..94069453 --- /dev/null +++ b/doc/man-docs/harbor-health.1 @@ -0,0 +1,45 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-health - Get the health status of Harbor components + + +.SH SYNOPSIS +\fBharbor health [flags]\fP + + +.SH DESCRIPTION +Get the health status of Harbor components + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for health + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + # Get the health status of Harbor components +.EE + + +.SH SEE ALSO +\fBharbor(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-create.1 b/doc/man-docs/harbor-label-create.1 new file mode 100644 index 00000000..5b79a085 --- /dev/null +++ b/doc/man-docs/harbor-label-create.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-create - create label + + +.SH SYNOPSIS +\fBharbor label create [flags]\fP + + +.SH DESCRIPTION +create label in harbor + + +.SH OPTIONS +\fB--color\fP="#FFFFFF" + Color of the label.color is in hex value + +.PP +\fB-d\fP, \fB--description\fP="" + Description of the label + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + +.PP +\fB-n\fP, \fB--name\fP="" + Name of the label + +.PP +\fB-s\fP, \fB--scope\fP="g" + Scope of the label. eg- g(global), p(specific project) + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor label create +.EE + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-delete.1 b/doc/man-docs/harbor-label-delete.1 new file mode 100644 index 00000000..baffb260 --- /dev/null +++ b/doc/man-docs/harbor-label-delete.1 @@ -0,0 +1,49 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-delete - delete label + + +.SH SYNOPSIS +\fBharbor label delete [flags]\fP + + +.SH DESCRIPTION +delete label + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for delete + +.PP +\fB-s\fP, \fB--scope\fP="g" + default(global).'p' for project labels.Query scope of the label + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor label delete [labelname] +.EE + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-list.1 b/doc/man-docs/harbor-label-list.1 new file mode 100644 index 00000000..36dd243f --- /dev/null +++ b/doc/man-docs/harbor-label-list.1 @@ -0,0 +1,63 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-list - list labels + + +.SH SYNOPSIS +\fBharbor label list [flags]\fP + + +.SH DESCRIPTION +list labels + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=20 + Size of per page + +.PP +\fB-i\fP, \fB--projectid\fP=1 + project ID when query project labels + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB-s\fP, \fB--scope\fP="g" + default(global).'p' for project labels.Query scope of the label + +.PP +\fB--sort\fP="" + Sort the label list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-update.1 b/doc/man-docs/harbor-label-update.1 new file mode 100644 index 00000000..39fa1556 --- /dev/null +++ b/doc/man-docs/harbor-label-update.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-update - update label + + +.SH SYNOPSIS +\fBharbor label update [flags]\fP + + +.SH DESCRIPTION +update label + + +.SH OPTIONS +\fB--color\fP="" + Color of the label.color is in hex value + +.PP +\fB-d\fP, \fB--description\fP="" + Description of the label + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for update + +.PP +\fB-n\fP, \fB--name\fP="" + Name of the label + +.PP +\fB-s\fP, \fB--scope\fP="g" + Scope of the label. eg- g(global), p(specific project) + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor label update [labelname] +.EE + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label.1 b/doc/man-docs/harbor-label.1 new file mode 100644 index 00000000..83566bba --- /dev/null +++ b/doc/man-docs/harbor-label.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label - Manage labels in Harbor + + +.SH SYNOPSIS +\fBharbor label [flags]\fP + + +.SH DESCRIPTION +Manage labels in Harbor + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for label + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor(1)\fP, \fBharbor-label-create(1)\fP, \fBharbor-label-delete(1)\fP, \fBharbor-label-list(1)\fP, \fBharbor-label-update(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-login.1 b/doc/man-docs/harbor-login.1 similarity index 67% rename from doc/man_docs/harbor-login.1 rename to doc/man-docs/harbor-login.1 index 015946a6..1a7224f0 100644 --- a/doc/man_docs/harbor-login.1 +++ b/doc/man-docs/harbor-login.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-login - Log in to Harbor registry .SH SYNOPSIS -.PP \fBharbor login [server] [flags]\fP .SH DESCRIPTION -.PP Authenticate with Harbor Registry. .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for login @@ -29,15 +25,18 @@ Authenticate with Harbor Registry. \fB-p\fP, \fB--password\fP="" Password +.PP +\fB--password-stdin\fP[=false] + Take the password from stdin + .PP \fB-u\fP, \fB--username\fP="" Username .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -49,5 +48,8 @@ Authenticate with Harbor Registry. .SH SEE ALSO -.PP \fBharbor(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-create.1 b/doc/man-docs/harbor-project-create.1 similarity index 67% rename from doc/man_docs/harbor-project-create.1 rename to doc/man-docs/harbor-project-create.1 index ed05c0e1..ec1c9926 100644 --- a/doc/man_docs/harbor-project-create.1 +++ b/doc/man-docs/harbor-project-create.1 @@ -1,37 +1,29 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-create - create project .SH SYNOPSIS -.PP -\fBharbor project create [flags]\fP +\fBharbor project create [project name] [flags]\fP .SH DESCRIPTION -.PP create project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for create -.PP -\fB--name\fP="" - Name of the project - .PP \fB--proxy-cache\fP[=false] Whether the project is a proxy cache project .PP \fB--public\fP[=false] - Project is public or private. Private by default + Project is public or private .PP \fB--registry-id\fP="" @@ -43,9 +35,8 @@ create project .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -57,5 +48,8 @@ create project .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-delete.1 b/doc/man-docs/harbor-project-delete.1 similarity index 60% rename from doc/man_docs/harbor-project-delete.1 rename to doc/man-docs/harbor-project-delete.1 index 80d67878..8894e565 100644 --- a/doc/man_docs/harbor-project-delete.1 +++ b/doc/man-docs/harbor-project-delete.1 @@ -1,31 +1,30 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-delete - delete project by name or id .SH SYNOPSIS -.PP \fBharbor project delete [flags]\fP .SH DESCRIPTION -.PP delete project by name or id .SH OPTIONS +\fB--force\fP[=false] + Deletes all repositories and artifacts within the project + .PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +36,8 @@ delete project by name or id .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-list.1 b/doc/man-docs/harbor-project-list.1 similarity index 70% rename from doc/man_docs/harbor-project-list.1 rename to doc/man-docs/harbor-project-list.1 index 198a6561..22f647fb 100644 --- a/doc/man_docs/harbor-project-list.1 +++ b/doc/man-docs/harbor-project-list.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-list - list project .SH SYNOPSIS -.PP \fBharbor project list [flags]\fP .SH DESCRIPTION -.PP list project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list @@ -33,9 +29,13 @@ list project \fB--page-size\fP=10 Size of per page +.PP +\fB--private\fP[=false] + Show only private projects + .PP \fB--public\fP[=false] - Project is public or private + Show only public projects .PP \fB-q\fP, \fB--query\fP="" @@ -47,9 +47,8 @@ list project .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -61,5 +60,8 @@ list project .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-logs.1 b/doc/man-docs/harbor-project-logs.1 similarity index 66% rename from doc/man_docs/harbor-project-logs.1 rename to doc/man-docs/harbor-project-logs.1 index 6293920e..767e306b 100644 --- a/doc/man_docs/harbor-project-logs.1 +++ b/doc/man-docs/harbor-project-logs.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-logs - get project logs .SH SYNOPSIS -.PP \fBharbor project logs [flags]\fP .SH DESCRIPTION -.PP get project logs .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for logs .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ get project logs .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-project-search.1 b/doc/man-docs/harbor-project-search.1 new file mode 100644 index 00000000..ec8483aa --- /dev/null +++ b/doc/man-docs/harbor-project-search.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-project-search - search project based on their names + + +.SH SYNOPSIS +\fBharbor project search [flags]\fP + + +.SH DESCRIPTION +search project based on their names + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for search + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-view.1 b/doc/man-docs/harbor-project-view.1 similarity index 67% rename from doc/man_docs/harbor-project-view.1 rename to doc/man-docs/harbor-project-view.1 index c987ed89..70fbab94 100644 --- a/doc/man_docs/harbor-project-view.1 +++ b/doc/man-docs/harbor-project-view.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-view - get project by name or id .SH SYNOPSIS -.PP \fBharbor project view [NAME|ID] [flags]\fP .SH DESCRIPTION -.PP get project by name or id .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for view .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ get project by name or id .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project.1 b/doc/man-docs/harbor-project.1 similarity index 67% rename from doc/man_docs/harbor-project.1 rename to doc/man-docs/harbor-project.1 index 19242e0d..3852fd59 100644 --- a/doc/man_docs/harbor-project.1 +++ b/doc/man-docs/harbor-project.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project - Manage projects and assign resources to them .SH SYNOPSIS -.PP \fBharbor project [flags]\fP .SH DESCRIPTION -.PP Manage projects in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for project .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage projects in Harbor .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-project-create(1)\fP, \fBharbor-project-delete(1)\fP, \fBharbor-project-list(1)\fP, \fBharbor-project-logs(1)\fP, \fBharbor-project-view(1)\fP +\fBharbor(1)\fP, \fBharbor-project-create(1)\fP, \fBharbor-project-delete(1)\fP, \fBharbor-project-list(1)\fP, \fBharbor-project-logs(1)\fP, \fBharbor-project-search(1)\fP, \fBharbor-project-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-create.1 b/doc/man-docs/harbor-registry-create.1 similarity index 73% rename from doc/man_docs/harbor-registry-create.1 rename to doc/man-docs/harbor-registry-create.1 index ef6b4250..f202adaa 100644 --- a/doc/man_docs/harbor-registry-create.1 +++ b/doc/man-docs/harbor-registry-create.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry-create - create registry .SH SYNOPSIS -.PP \fBharbor registry create [flags]\fP .SH DESCRIPTION -.PP create registry .SH OPTIONS -.PP \fB--credential-access-key\fP="" Access key, e.g. user name when credential type is 'basic' @@ -39,14 +35,14 @@ create registry .PP \fB--insecure\fP[=true] - Whether or not the certificate will be verified when Harbor tries to access the server + Whether Harbor will verify the server certificate .PP \fB--name\fP="" Name of the registry .PP -\fB--type\fP="harbor" +\fB--type\fP="" Type of the registry .PP @@ -55,9 +51,8 @@ create registry .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -68,6 +63,15 @@ create registry verbose output +.SH EXAMPLE +.EX +harbor registry create +.EE + + .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-delete.1 b/doc/man-docs/harbor-registry-delete.1 similarity index 52% rename from doc/man_docs/harbor-registry-delete.1 rename to doc/man-docs/harbor-registry-delete.1 index 1b6e2a86..bc429e90 100644 --- a/doc/man_docs/harbor-registry-delete.1 +++ b/doc/man-docs/harbor-registry-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP -harbor-registry-delete - delete registry by id +harbor-registry-delete - delete registry .SH SYNOPSIS -.PP \fBharbor registry delete [flags]\fP .SH DESCRIPTION -.PP -delete registry by id +delete registry .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -36,6 +31,15 @@ delete registry by id verbose output +.SH EXAMPLE +.EX +harbor registry delete [registryname] +.EE + + .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-list.1 b/doc/man-docs/harbor-registry-list.1 similarity index 74% rename from doc/man_docs/harbor-registry-list.1 rename to doc/man-docs/harbor-registry-list.1 index 696c4c90..4694e311 100644 --- a/doc/man_docs/harbor-registry-list.1 +++ b/doc/man-docs/harbor-registry-list.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry-list - list registry .SH SYNOPSIS -.PP \fBharbor registry list [flags]\fP .SH DESCRIPTION -.PP list registry .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list @@ -39,9 +35,8 @@ list registry .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -53,5 +48,8 @@ list registry .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-update.1 b/doc/man-docs/harbor-registry-update.1 similarity index 61% rename from doc/man_docs/harbor-registry-update.1 rename to doc/man-docs/harbor-registry-update.1 index ef56aa43..9a1cdd6e 100644 --- a/doc/man_docs/harbor-registry-update.1 +++ b/doc/man-docs/harbor-registry-update.1 @@ -1,28 +1,24 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry-update - update registry .SH SYNOPSIS -.PP -\fBharbor registry update [flags]\fP +\fBharbor registry update [registry_name] [flags]\fP .SH DESCRIPTION -.PP update registry .SH OPTIONS -.PP -\fB--credential-access-key\fP="" +\fB-k\fP, \fB--credential-access-key\fP="" Access key, e.g. user name when credential type is 'basic' .PP -\fB--credential-access-secret\fP="" +\fB-s\fP, \fB--credential-access-secret\fP="" Access secret, e.g. password when credential type is 'basic' .PP @@ -30,7 +26,7 @@ update registry Credential type, such as 'basic', 'oauth' .PP -\fB--description\fP="" +\fB-d\fP, \fB--description\fP="" Description of the registry .PP @@ -38,26 +34,25 @@ update registry help for update .PP -\fB--insecure\fP[=true] +\fB-i\fP, \fB--insecure\fP[=false] Whether or not the certificate will be verified when Harbor tries to access the server .PP -\fB--name\fP="" +\fB-n\fP, \fB--name\fP="" Name of the registry .PP -\fB--type\fP="" +\fB-t\fP, \fB--type\fP="" Type of the registry .PP -\fB--url\fP="" +\fB-u\fP, \fB--url\fP="" Registry endpoint URL .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -69,5 +64,8 @@ update registry .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-view.1 b/doc/man-docs/harbor-registry-view.1 similarity index 51% rename from doc/man_docs/harbor-registry-view.1 rename to doc/man-docs/harbor-registry-view.1 index ee94b57b..b4c725ee 100644 --- a/doc/man_docs/harbor-registry-view.1 +++ b/doc/man-docs/harbor-registry-view.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP -harbor-registry-view - get registry by id +harbor-registry-view - get registry information .SH SYNOPSIS -.PP \fBharbor registry view [flags]\fP .SH DESCRIPTION -.PP -get registry by id +get registry information .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for view .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -36,6 +31,15 @@ get registry by id verbose output +.SH EXAMPLE +.EX +harbor registry view [registryName] +.EE + + .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry.1 b/doc/man-docs/harbor-registry.1 similarity index 60% rename from doc/man_docs/harbor-registry.1 rename to doc/man-docs/harbor-registry.1 index 2675b79c..c6868c46 100644 --- a/doc/man_docs/harbor-registry.1 +++ b/doc/man-docs/harbor-registry.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry - Manage registries .SH SYNOPSIS -.PP \fBharbor registry [flags]\fP .SH DESCRIPTION -.PP Manage registries in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for registry .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage registries in Harbor .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-registry-create(1)\fP, \fBharbor-registry-delete(1)\fP, \fBharbor-registry-info(1)\fP, \fBharbor-registry-list(1)\fP, \fBharbor-registry-update(1)\fP, \fBharbor-registry-view(1)\fP +\fBharbor(1)\fP, \fBharbor-registry-create(1)\fP, \fBharbor-registry-delete(1)\fP, \fBharbor-registry-list(1)\fP, \fBharbor-registry-update(1)\fP, \fBharbor-registry-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo-delete.1 b/doc/man-docs/harbor-repo-delete.1 similarity index 71% rename from doc/man_docs/harbor-repo-delete.1 rename to doc/man-docs/harbor-repo-delete.1 index 8ed1eeba..3f871754 100644 --- a/doc/man_docs/harbor-repo-delete.1 +++ b/doc/man-docs/harbor-repo-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-repo-delete - Delete a repository .SH SYNOPSIS -.PP \fBharbor repo delete [flags]\fP .SH DESCRIPTION -.PP Delete a repository within a project in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Delete a repository within a project in Harbor .SH SEE ALSO -.PP \fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo-list.1 b/doc/man-docs/harbor-repo-list.1 similarity index 56% rename from doc/man_docs/harbor-repo-list.1 rename to doc/man-docs/harbor-repo-list.1 index c1d12ee3..473db8c4 100644 --- a/doc/man_docs/harbor-repo-list.1 +++ b/doc/man-docs/harbor-repo-list.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-repo-list - list repositories within a project .SH SYNOPSIS -.PP \fBharbor repo list [flags]\fP .SH DESCRIPTION -.PP -list repositories within a project +Get information of all repositories in a project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -36,6 +31,15 @@ list repositories within a project verbose output +.SH EXAMPLE +.EX + harbor repo list +.EE + + .SH SEE ALSO -.PP \fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-repo-search.1 b/doc/man-docs/harbor-repo-search.1 new file mode 100644 index 00000000..99eb69f2 --- /dev/null +++ b/doc/man-docs/harbor-repo-search.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-repo-search - search repository based on their names + + +.SH SYNOPSIS +\fBharbor repo search [flags]\fP + + +.SH DESCRIPTION +search repository based on their names + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for search + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo-info.1 b/doc/man-docs/harbor-repo-view.1 similarity index 52% rename from doc/man_docs/harbor-repo-info.1 rename to doc/man-docs/harbor-repo-view.1 index a6dba505..231b8879 100644 --- a/doc/man_docs/harbor-repo-info.1 +++ b/doc/man-docs/harbor-repo-view.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP -harbor-repo-info - Get repository information +harbor-repo-view - Get repository information .SH SYNOPSIS -.PP -\fBharbor repo info [flags]\fP +\fBharbor repo view [flags]\fP .SH DESCRIPTION -.PP Get information of a particular repository in a project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] - help for info + help for view .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -38,10 +33,13 @@ Get information of a particular repository in a project .SH EXAMPLE .EX - harbor repo info / + harbor repo view / .EE .SH SEE ALSO -.PP \fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo.1 b/doc/man-docs/harbor-repo.1 similarity index 54% rename from doc/man_docs/harbor-repo.1 rename to doc/man-docs/harbor-repo.1 index 6f561d0c..052f6739 100644 --- a/doc/man_docs/harbor-repo.1 +++ b/doc/man-docs/harbor-repo.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-repo - Manage repositories .SH SYNOPSIS -.PP \fBharbor repo [flags]\fP .SH DESCRIPTION -.PP Manage repositories in Harbor context .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for repo .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ Manage repositories in Harbor context .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-repo-delete(1)\fP, \fBharbor-repo-info(1)\fP, \fBharbor-repo-list(1)\fP +\fBharbor(1)\fP, \fBharbor-repo-delete(1)\fP, \fBharbor-repo-list(1)\fP, \fBharbor-repo-search(1)\fP, \fBharbor-repo-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-schedule-list.1 b/doc/man-docs/harbor-schedule-list.1 new file mode 100644 index 00000000..c6b8df09 --- /dev/null +++ b/doc/man-docs/harbor-schedule-list.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-schedule-list - show all schedule jobs in Harbor + + +.SH SYNOPSIS +\fBharbor schedule list [flags]\fP + + +.SH DESCRIPTION +show all schedule jobs in Harbor + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=10 + Size of per page + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-schedule(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-schedule.1 b/doc/man-docs/harbor-schedule.1 new file mode 100644 index 00000000..43cd0b92 --- /dev/null +++ b/doc/man-docs/harbor-schedule.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-schedule - Schedule jobs in Harbor + + +.SH SYNOPSIS +\fBharbor schedule [flags]\fP + + +.SH DESCRIPTION +Schedule jobs in Harbor + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for schedule + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor(1)\fP, \fBharbor-schedule-list(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user-create.1 b/doc/man-docs/harbor-user-create.1 similarity index 72% rename from doc/man_docs/harbor-user-create.1 rename to doc/man-docs/harbor-user-create.1 index 9934fbd7..46594581 100644 --- a/doc/man_docs/harbor-user-create.1 +++ b/doc/man-docs/harbor-user-create.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user-create - create user .SH SYNOPSIS -.PP \fBharbor user create [flags]\fP .SH DESCRIPTION -.PP create user .SH OPTIONS -.PP \fB--comment\fP="" Comment @@ -43,9 +39,8 @@ create user .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -57,5 +52,8 @@ create user .SH SEE ALSO -.PP \fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user-delete.1 b/doc/man-docs/harbor-user-delete.1 similarity index 65% rename from doc/man_docs/harbor-user-delete.1 rename to doc/man-docs/harbor-user-delete.1 index 372ae297..32f36ab6 100644 --- a/doc/man_docs/harbor-user-delete.1 +++ b/doc/man-docs/harbor-user-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user-delete - delete user .SH SYNOPSIS -.PP \fBharbor user delete [flags]\fP .SH DESCRIPTION -.PP delete user .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ delete user .SH SEE ALSO -.PP \fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user-elevate.1 b/doc/man-docs/harbor-user-elevate.1 similarity index 66% rename from doc/man_docs/harbor-user-elevate.1 rename to doc/man-docs/harbor-user-elevate.1 index 3bc57ac4..1dc19278 100644 --- a/doc/man_docs/harbor-user-elevate.1 +++ b/doc/man-docs/harbor-user-elevate.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user-elevate - elevate user .SH SYNOPSIS -.PP \fBharbor user elevate [flags]\fP .SH DESCRIPTION -.PP elevate user to admin role .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for elevate .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ elevate user to admin role .SH SEE ALSO -.PP \fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-user-list.1 b/doc/man-docs/harbor-user-list.1 new file mode 100644 index 00000000..2c25bc2e --- /dev/null +++ b/doc/man-docs/harbor-user-list.1 @@ -0,0 +1,55 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-user-list - list users + + +.SH SYNOPSIS +\fBharbor user list [flags]\fP + + +.SH DESCRIPTION +list users + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB-p\fP, \fB--page\fP=1 + Page number + +.PP +\fB-n\fP, \fB--page-size\fP=10 + Size of per page + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB-s\fP, \fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user.1 b/doc/man-docs/harbor-user.1 similarity index 72% rename from doc/man_docs/harbor-user.1 rename to doc/man-docs/harbor-user.1 index bde84e51..3407a95d 100644 --- a/doc/man_docs/harbor-user.1 +++ b/doc/man-docs/harbor-user.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user - Manage users .SH SYNOPSIS -.PP \fBharbor user [flags]\fP .SH DESCRIPTION -.PP Manage users in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for user .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage users in Harbor .SH SEE ALSO -.PP \fBharbor(1)\fP, \fBharbor-user-create(1)\fP, \fBharbor-user-delete(1)\fP, \fBharbor-user-elevate(1)\fP, \fBharbor-user-list(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-version.1 b/doc/man-docs/harbor-version.1 similarity index 71% rename from doc/man_docs/harbor-version.1 rename to doc/man-docs/harbor-version.1 index 90d60b02..0d80ae1c 100644 --- a/doc/man_docs/harbor-version.1 +++ b/doc/man-docs/harbor-version.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-version - Version of Harbor CLI .SH SYNOPSIS -.PP \fBharbor version [flags]\fP .SH DESCRIPTION -.PP Get Harbor CLI version, git commit, go version, build time, release channel, os/arch, etc. .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for version .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Get Harbor CLI version, git commit, go version, build time, release channel, os/ .SH SEE ALSO -.PP \fBharbor(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor.1 b/doc/man-docs/harbor.1 new file mode 100644 index 00000000..4675cbe5 --- /dev/null +++ b/doc/man-docs/harbor.1 @@ -0,0 +1,50 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor - Official Harbor CLI + + +.SH SYNOPSIS +\fBharbor [flags]\fP + + +.SH DESCRIPTION +Official Harbor CLI + + +.SH OPTIONS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for harbor + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + +// Base command: +harbor + +// Display help about the command: +harbor help + +.EE + + +.SH SEE ALSO +\fBharbor-artifact(1)\fP, \fBharbor-health(1)\fP, \fBharbor-label(1)\fP, \fBharbor-login(1)\fP, \fBharbor-project(1)\fP, \fBharbor-registry(1)\fP, \fBharbor-repo(1)\fP, \fBharbor-schedule(1)\fP, \fBharbor-user(1)\fP, \fBharbor-version(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-info.1 b/doc/man_docs/harbor-artifact-info.1 deleted file mode 100644 index 16be12b2..00000000 --- a/doc/man_docs/harbor-artifact-info.1 +++ /dev/null @@ -1,47 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor-artifact-info - Get info of an artifact - - -.SH SYNOPSIS -.PP -\fBharbor artifact info [flags]\fP - - -.SH DESCRIPTION -.PP -Get info of an artifact - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for info - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH EXAMPLE -.EX -harbor artifact info // -.EE - - -.SH SEE ALSO -.PP -\fBharbor-artifact(1)\fP diff --git a/doc/man_docs/harbor-registry-info.1 b/doc/man_docs/harbor-registry-info.1 deleted file mode 100644 index 69ef357a..00000000 --- a/doc/man_docs/harbor-registry-info.1 +++ /dev/null @@ -1,41 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor-registry-info - get registry info - - -.SH SYNOPSIS -.PP -\fBharbor registry info [flags]\fP - - -.SH DESCRIPTION -.PP -get registry info - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for info - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH SEE ALSO -.PP -\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-user-list.1 b/doc/man_docs/harbor-user-list.1 deleted file mode 100644 index e3f4cdaa..00000000 --- a/doc/man_docs/harbor-user-list.1 +++ /dev/null @@ -1,41 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor-user-list - list users - - -.SH SYNOPSIS -.PP -\fBharbor user list [flags]\fP - - -.SH DESCRIPTION -.PP -list users - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for list - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH SEE ALSO -.PP -\fBharbor-user(1)\fP diff --git a/doc/man_docs/harbor.1 b/doc/man_docs/harbor.1 deleted file mode 100644 index fa20a67c..00000000 --- a/doc/man_docs/harbor.1 +++ /dev/null @@ -1,51 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor - Official Harbor CLI - - -.SH SYNOPSIS -.PP -\fBharbor [flags]\fP - - -.SH DESCRIPTION -.PP -Official Harbor CLI - - -.SH OPTIONS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for harbor - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH EXAMPLE -.EX - -// Base command: -harbor - -// Display help about the command: -harbor help - -.EE - - -.SH SEE ALSO -.PP -\fBharbor-artifact(1)\fP, \fBharbor-login(1)\fP, \fBharbor-project(1)\fP, \fBharbor-registry(1)\fP, \fBharbor-repo(1)\fP, \fBharbor-user(1)\fP, \fBharbor-version(1)\fP From de126773447a461225482eb27e2e21675aa403be Mon Sep 17 00:00:00 2001 From: bupd Date: Sat, 28 Dec 2024 09:20:17 +0530 Subject: [PATCH 7/8] update workflow Signed-off-by: bupd --- .github/workflows/default.yaml | 15 ++++++++++++--- dagger/main.go | 6 +++--- doc/{doc.go => _doc.go} | 0 doc/{man_doc.go => _man_doc.go} | 0 4 files changed, 15 insertions(+), 6 deletions(-) rename doc/{doc.go => _doc.go} (100%) rename doc/{man_doc.go => _man_doc.go} (100%) diff --git a/.github/workflows/default.yaml b/.github/workflows/default.yaml index 55cc1d12..f21cdbcc 100644 --- a/.github/workflows/default.yaml +++ b/.github/workflows/default.yaml @@ -22,7 +22,7 @@ jobs: - name: Dagger Version uses: sagikazarmark/dagger-version-action@v0.0.1 - - name: Generate Documentation + - name: Generate Document uses: dagger/dagger-for-github@v7 with: version: ${{ steps.dagger_version.outputs.version }} @@ -31,8 +31,17 @@ jobs: - name: Check for changes run: | - # Check if any files were changed by document - git diff --exit-code + # Check if any untracked files exist + untracked_files=$(git ls-files --others --exclude-standard) + + # If there are untracked files, fail the workflow + if [ -n "$untracked_files" ]; then + echo "Untracked files found:" + echo "$untracked_files" + exit 1 # This will fail the workflow + else + echo "No untracked files found." + fi continue-on-error: false - name: Run Dagger golangci-lint diff --git a/dagger/main.go b/dagger/main.go index 3e128962..5578f3c0 100644 --- a/dagger/main.go +++ b/dagger/main.go @@ -98,7 +98,7 @@ func (m *HarborCli) LintReport(ctx context.Context) *dagger.File { return m.lint(ctx).WithExec([]string{ "golangci-lint", "run", "--out-format", "sarif:" + report, - "--issues-exit-code", "0", + "--issues-exit-code", "1", }).File(report) } @@ -219,8 +219,8 @@ func (m *HarborCli) RunDoc(ctx context.Context) *dagger.Directory { WithEnvVariable("GOCACHE", "/go/build-cache"). WithMountedDirectory("/src", m.Source). WithWorkdir("/src/doc"). - WithExec([]string{"go", "run", "doc.go"}). - WithExec([]string{"go", "run", "man_doc.go"}). + WithExec([]string{"go", "run", "_doc.go"}). + WithExec([]string{"go", "run", "_man_doc.go"}). WithWorkdir("/src").Directory("/src/doc") } diff --git a/doc/doc.go b/doc/_doc.go similarity index 100% rename from doc/doc.go rename to doc/_doc.go diff --git a/doc/man_doc.go b/doc/_man_doc.go similarity index 100% rename from doc/man_doc.go rename to doc/_man_doc.go From 21a5db4ecfde232a6f7de58e5e1bf11e13c67d23 Mon Sep 17 00:00:00 2001 From: bupd Date: Mon, 30 Dec 2024 04:19:58 +0530 Subject: [PATCH 8/8] move man pages to man1 Signed-off-by: bupd --- .golangci.yaml | 20 +++++ changes.patch | 79 +++++++++++++++++++ .../{ => man1}/harbor-artifact-delete.1 | 0 .../{ => man1}/harbor-artifact-list.1 | 0 .../{ => man1}/harbor-artifact-scan-start.1 | 0 .../{ => man1}/harbor-artifact-scan-stop.1 | 0 .../{ => man1}/harbor-artifact-scan.1 | 0 .../{ => man1}/harbor-artifact-tags-create.1 | 0 .../{ => man1}/harbor-artifact-tags-delete.1 | 0 .../{ => man1}/harbor-artifact-tags-list.1 | 0 .../{ => man1}/harbor-artifact-tags.1 | 0 .../{ => man1}/harbor-artifact-view.1 | 0 doc/man-docs/{ => man1}/harbor-artifact.1 | 0 doc/man-docs/{ => man1}/harbor-health.1 | 0 doc/man-docs/{ => man1}/harbor-label-create.1 | 0 doc/man-docs/{ => man1}/harbor-label-delete.1 | 0 doc/man-docs/{ => man1}/harbor-label-list.1 | 0 doc/man-docs/{ => man1}/harbor-label-update.1 | 0 doc/man-docs/{ => man1}/harbor-label.1 | 0 doc/man-docs/{ => man1}/harbor-login.1 | 0 .../{ => man1}/harbor-project-create.1 | 0 .../{ => man1}/harbor-project-delete.1 | 0 doc/man-docs/{ => man1}/harbor-project-list.1 | 0 doc/man-docs/{ => man1}/harbor-project-logs.1 | 0 .../{ => man1}/harbor-project-search.1 | 0 doc/man-docs/{ => man1}/harbor-project-view.1 | 0 doc/man-docs/{ => man1}/harbor-project.1 | 0 .../{ => man1}/harbor-registry-create.1 | 0 .../{ => man1}/harbor-registry-delete.1 | 0 .../{ => man1}/harbor-registry-list.1 | 0 .../{ => man1}/harbor-registry-update.1 | 0 .../{ => man1}/harbor-registry-view.1 | 0 doc/man-docs/{ => man1}/harbor-registry.1 | 0 doc/man-docs/{ => man1}/harbor-repo-delete.1 | 0 doc/man-docs/{ => man1}/harbor-repo-list.1 | 0 doc/man-docs/{ => man1}/harbor-repo-search.1 | 0 doc/man-docs/{ => man1}/harbor-repo-view.1 | 0 doc/man-docs/{ => man1}/harbor-repo.1 | 0 .../{ => man1}/harbor-schedule-list.1 | 0 doc/man-docs/{ => man1}/harbor-schedule.1 | 0 doc/man-docs/{ => man1}/harbor-user-create.1 | 0 doc/man-docs/{ => man1}/harbor-user-delete.1 | 0 doc/man-docs/{ => man1}/harbor-user-elevate.1 | 0 doc/man-docs/{ => man1}/harbor-user-list.1 | 0 doc/man-docs/{ => man1}/harbor-user.1 | 0 doc/man-docs/{ => man1}/harbor-version.1 | 0 doc/man-docs/{ => man1}/harbor.1 | 0 pkg/views/artifact/list/view.go | 5 +- pkg/views/artifact/view/view.go | 5 +- 49 files changed, 105 insertions(+), 4 deletions(-) create mode 100644 changes.patch rename doc/man-docs/{ => man1}/harbor-artifact-delete.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-scan-start.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-scan-stop.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-scan.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-tags-create.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-tags-delete.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-tags-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-tags.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact-view.1 (100%) rename doc/man-docs/{ => man1}/harbor-artifact.1 (100%) rename doc/man-docs/{ => man1}/harbor-health.1 (100%) rename doc/man-docs/{ => man1}/harbor-label-create.1 (100%) rename doc/man-docs/{ => man1}/harbor-label-delete.1 (100%) rename doc/man-docs/{ => man1}/harbor-label-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-label-update.1 (100%) rename doc/man-docs/{ => man1}/harbor-label.1 (100%) rename doc/man-docs/{ => man1}/harbor-login.1 (100%) rename doc/man-docs/{ => man1}/harbor-project-create.1 (100%) rename doc/man-docs/{ => man1}/harbor-project-delete.1 (100%) rename doc/man-docs/{ => man1}/harbor-project-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-project-logs.1 (100%) rename doc/man-docs/{ => man1}/harbor-project-search.1 (100%) rename doc/man-docs/{ => man1}/harbor-project-view.1 (100%) rename doc/man-docs/{ => man1}/harbor-project.1 (100%) rename doc/man-docs/{ => man1}/harbor-registry-create.1 (100%) rename doc/man-docs/{ => man1}/harbor-registry-delete.1 (100%) rename doc/man-docs/{ => man1}/harbor-registry-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-registry-update.1 (100%) rename doc/man-docs/{ => man1}/harbor-registry-view.1 (100%) rename doc/man-docs/{ => man1}/harbor-registry.1 (100%) rename doc/man-docs/{ => man1}/harbor-repo-delete.1 (100%) rename doc/man-docs/{ => man1}/harbor-repo-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-repo-search.1 (100%) rename doc/man-docs/{ => man1}/harbor-repo-view.1 (100%) rename doc/man-docs/{ => man1}/harbor-repo.1 (100%) rename doc/man-docs/{ => man1}/harbor-schedule-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-schedule.1 (100%) rename doc/man-docs/{ => man1}/harbor-user-create.1 (100%) rename doc/man-docs/{ => man1}/harbor-user-delete.1 (100%) rename doc/man-docs/{ => man1}/harbor-user-elevate.1 (100%) rename doc/man-docs/{ => man1}/harbor-user-list.1 (100%) rename doc/man-docs/{ => man1}/harbor-user.1 (100%) rename doc/man-docs/{ => man1}/harbor-version.1 (100%) rename doc/man-docs/{ => man1}/harbor.1 (100%) diff --git a/.golangci.yaml b/.golangci.yaml index b9a4d4f2..fb281a93 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -1,12 +1,32 @@ run: timeout: 3m +linters-settings: + gofmt: + # Simplify code: gofmt with `-s` option. + # Default: true + simplify: false + misspell: + locale: US,UK + stylecheck: + checks: [ + "ST1019", # Importing the same package multiple times. + ] + goheader: + template-path: copyright.tmpl + linters: enable: # Default linters are already enabled, these are the additional ones + - gosimple - typecheck - gofmt + - goimports - gosec - nilnil + - unused + - errcheck + - staticcheck + - dupl # - wrapcheck # - gocritic # - revive #, enable once current issues are resolved diff --git a/changes.patch b/changes.patch new file mode 100644 index 00000000..0dc8084f --- /dev/null +++ b/changes.patch @@ -0,0 +1,79 @@ +diff --git a/.golangci.yaml b/.golangci.yaml +index b9a4d4f27..fb281a936 100644 +--- a/.golangci.yaml ++++ b/.golangci.yaml +@@ -1,12 +1,32 @@ + run: + timeout: 3m ++linters-settings: ++ gofmt: ++ # Simplify code: gofmt with `-s` option. ++ # Default: true ++ simplify: false ++ misspell: ++ locale: US,UK ++ stylecheck: ++ checks: [ ++ "ST1019", # Importing the same package multiple times. ++ ] ++ goheader: ++ template-path: copyright.tmpl ++ + linters: + enable: + # Default linters are already enabled, these are the additional ones ++ - gosimple + - typecheck + - gofmt ++ - goimports + - gosec + - nilnil ++ - unused ++ - errcheck ++ - staticcheck ++ - dupl + # - wrapcheck + # - gocritic + # - revive #, enable once current issues are resolved +diff --git a/pkg/views/artifact/list/view.go b/pkg/views/artifact/list/view.go +index 3b851aeeb..62901de74 100644 +--- a/pkg/views/artifact/list/view.go ++++ b/pkg/views/artifact/list/view.go +@@ -2,13 +2,14 @@ package list + + import ( + "fmt" ++ "os" ++ "strconv" ++ + "github.com/charmbracelet/bubbles/table" + tea "github.com/charmbracelet/bubbletea" + "github.com/goharbor/go-client/pkg/sdk/v2.0/models" + "github.com/goharbor/harbor-cli/pkg/utils" + "github.com/goharbor/harbor-cli/pkg/views/base/tablelist" +- "os" +- "strconv" + ) + + var columns = []table.Column{ +diff --git a/pkg/views/artifact/view/view.go b/pkg/views/artifact/view/view.go +index 0ab46ae7f..13288d17b 100644 +--- a/pkg/views/artifact/view/view.go ++++ b/pkg/views/artifact/view/view.go +@@ -2,13 +2,14 @@ package view + + import ( + "fmt" ++ "os" ++ "strconv" ++ + "github.com/charmbracelet/bubbles/table" + tea "github.com/charmbracelet/bubbletea" + "github.com/goharbor/go-client/pkg/sdk/v2.0/models" + "github.com/goharbor/harbor-cli/pkg/utils" + "github.com/goharbor/harbor-cli/pkg/views/base/tablelist" +- "os" +- "strconv" + ) + + var columns = []table.Column{ diff --git a/doc/man-docs/harbor-artifact-delete.1 b/doc/man-docs/man1/harbor-artifact-delete.1 similarity index 100% rename from doc/man-docs/harbor-artifact-delete.1 rename to doc/man-docs/man1/harbor-artifact-delete.1 diff --git a/doc/man-docs/harbor-artifact-list.1 b/doc/man-docs/man1/harbor-artifact-list.1 similarity index 100% rename from doc/man-docs/harbor-artifact-list.1 rename to doc/man-docs/man1/harbor-artifact-list.1 diff --git a/doc/man-docs/harbor-artifact-scan-start.1 b/doc/man-docs/man1/harbor-artifact-scan-start.1 similarity index 100% rename from doc/man-docs/harbor-artifact-scan-start.1 rename to doc/man-docs/man1/harbor-artifact-scan-start.1 diff --git a/doc/man-docs/harbor-artifact-scan-stop.1 b/doc/man-docs/man1/harbor-artifact-scan-stop.1 similarity index 100% rename from doc/man-docs/harbor-artifact-scan-stop.1 rename to doc/man-docs/man1/harbor-artifact-scan-stop.1 diff --git a/doc/man-docs/harbor-artifact-scan.1 b/doc/man-docs/man1/harbor-artifact-scan.1 similarity index 100% rename from doc/man-docs/harbor-artifact-scan.1 rename to doc/man-docs/man1/harbor-artifact-scan.1 diff --git a/doc/man-docs/harbor-artifact-tags-create.1 b/doc/man-docs/man1/harbor-artifact-tags-create.1 similarity index 100% rename from doc/man-docs/harbor-artifact-tags-create.1 rename to doc/man-docs/man1/harbor-artifact-tags-create.1 diff --git a/doc/man-docs/harbor-artifact-tags-delete.1 b/doc/man-docs/man1/harbor-artifact-tags-delete.1 similarity index 100% rename from doc/man-docs/harbor-artifact-tags-delete.1 rename to doc/man-docs/man1/harbor-artifact-tags-delete.1 diff --git a/doc/man-docs/harbor-artifact-tags-list.1 b/doc/man-docs/man1/harbor-artifact-tags-list.1 similarity index 100% rename from doc/man-docs/harbor-artifact-tags-list.1 rename to doc/man-docs/man1/harbor-artifact-tags-list.1 diff --git a/doc/man-docs/harbor-artifact-tags.1 b/doc/man-docs/man1/harbor-artifact-tags.1 similarity index 100% rename from doc/man-docs/harbor-artifact-tags.1 rename to doc/man-docs/man1/harbor-artifact-tags.1 diff --git a/doc/man-docs/harbor-artifact-view.1 b/doc/man-docs/man1/harbor-artifact-view.1 similarity index 100% rename from doc/man-docs/harbor-artifact-view.1 rename to doc/man-docs/man1/harbor-artifact-view.1 diff --git a/doc/man-docs/harbor-artifact.1 b/doc/man-docs/man1/harbor-artifact.1 similarity index 100% rename from doc/man-docs/harbor-artifact.1 rename to doc/man-docs/man1/harbor-artifact.1 diff --git a/doc/man-docs/harbor-health.1 b/doc/man-docs/man1/harbor-health.1 similarity index 100% rename from doc/man-docs/harbor-health.1 rename to doc/man-docs/man1/harbor-health.1 diff --git a/doc/man-docs/harbor-label-create.1 b/doc/man-docs/man1/harbor-label-create.1 similarity index 100% rename from doc/man-docs/harbor-label-create.1 rename to doc/man-docs/man1/harbor-label-create.1 diff --git a/doc/man-docs/harbor-label-delete.1 b/doc/man-docs/man1/harbor-label-delete.1 similarity index 100% rename from doc/man-docs/harbor-label-delete.1 rename to doc/man-docs/man1/harbor-label-delete.1 diff --git a/doc/man-docs/harbor-label-list.1 b/doc/man-docs/man1/harbor-label-list.1 similarity index 100% rename from doc/man-docs/harbor-label-list.1 rename to doc/man-docs/man1/harbor-label-list.1 diff --git a/doc/man-docs/harbor-label-update.1 b/doc/man-docs/man1/harbor-label-update.1 similarity index 100% rename from doc/man-docs/harbor-label-update.1 rename to doc/man-docs/man1/harbor-label-update.1 diff --git a/doc/man-docs/harbor-label.1 b/doc/man-docs/man1/harbor-label.1 similarity index 100% rename from doc/man-docs/harbor-label.1 rename to doc/man-docs/man1/harbor-label.1 diff --git a/doc/man-docs/harbor-login.1 b/doc/man-docs/man1/harbor-login.1 similarity index 100% rename from doc/man-docs/harbor-login.1 rename to doc/man-docs/man1/harbor-login.1 diff --git a/doc/man-docs/harbor-project-create.1 b/doc/man-docs/man1/harbor-project-create.1 similarity index 100% rename from doc/man-docs/harbor-project-create.1 rename to doc/man-docs/man1/harbor-project-create.1 diff --git a/doc/man-docs/harbor-project-delete.1 b/doc/man-docs/man1/harbor-project-delete.1 similarity index 100% rename from doc/man-docs/harbor-project-delete.1 rename to doc/man-docs/man1/harbor-project-delete.1 diff --git a/doc/man-docs/harbor-project-list.1 b/doc/man-docs/man1/harbor-project-list.1 similarity index 100% rename from doc/man-docs/harbor-project-list.1 rename to doc/man-docs/man1/harbor-project-list.1 diff --git a/doc/man-docs/harbor-project-logs.1 b/doc/man-docs/man1/harbor-project-logs.1 similarity index 100% rename from doc/man-docs/harbor-project-logs.1 rename to doc/man-docs/man1/harbor-project-logs.1 diff --git a/doc/man-docs/harbor-project-search.1 b/doc/man-docs/man1/harbor-project-search.1 similarity index 100% rename from doc/man-docs/harbor-project-search.1 rename to doc/man-docs/man1/harbor-project-search.1 diff --git a/doc/man-docs/harbor-project-view.1 b/doc/man-docs/man1/harbor-project-view.1 similarity index 100% rename from doc/man-docs/harbor-project-view.1 rename to doc/man-docs/man1/harbor-project-view.1 diff --git a/doc/man-docs/harbor-project.1 b/doc/man-docs/man1/harbor-project.1 similarity index 100% rename from doc/man-docs/harbor-project.1 rename to doc/man-docs/man1/harbor-project.1 diff --git a/doc/man-docs/harbor-registry-create.1 b/doc/man-docs/man1/harbor-registry-create.1 similarity index 100% rename from doc/man-docs/harbor-registry-create.1 rename to doc/man-docs/man1/harbor-registry-create.1 diff --git a/doc/man-docs/harbor-registry-delete.1 b/doc/man-docs/man1/harbor-registry-delete.1 similarity index 100% rename from doc/man-docs/harbor-registry-delete.1 rename to doc/man-docs/man1/harbor-registry-delete.1 diff --git a/doc/man-docs/harbor-registry-list.1 b/doc/man-docs/man1/harbor-registry-list.1 similarity index 100% rename from doc/man-docs/harbor-registry-list.1 rename to doc/man-docs/man1/harbor-registry-list.1 diff --git a/doc/man-docs/harbor-registry-update.1 b/doc/man-docs/man1/harbor-registry-update.1 similarity index 100% rename from doc/man-docs/harbor-registry-update.1 rename to doc/man-docs/man1/harbor-registry-update.1 diff --git a/doc/man-docs/harbor-registry-view.1 b/doc/man-docs/man1/harbor-registry-view.1 similarity index 100% rename from doc/man-docs/harbor-registry-view.1 rename to doc/man-docs/man1/harbor-registry-view.1 diff --git a/doc/man-docs/harbor-registry.1 b/doc/man-docs/man1/harbor-registry.1 similarity index 100% rename from doc/man-docs/harbor-registry.1 rename to doc/man-docs/man1/harbor-registry.1 diff --git a/doc/man-docs/harbor-repo-delete.1 b/doc/man-docs/man1/harbor-repo-delete.1 similarity index 100% rename from doc/man-docs/harbor-repo-delete.1 rename to doc/man-docs/man1/harbor-repo-delete.1 diff --git a/doc/man-docs/harbor-repo-list.1 b/doc/man-docs/man1/harbor-repo-list.1 similarity index 100% rename from doc/man-docs/harbor-repo-list.1 rename to doc/man-docs/man1/harbor-repo-list.1 diff --git a/doc/man-docs/harbor-repo-search.1 b/doc/man-docs/man1/harbor-repo-search.1 similarity index 100% rename from doc/man-docs/harbor-repo-search.1 rename to doc/man-docs/man1/harbor-repo-search.1 diff --git a/doc/man-docs/harbor-repo-view.1 b/doc/man-docs/man1/harbor-repo-view.1 similarity index 100% rename from doc/man-docs/harbor-repo-view.1 rename to doc/man-docs/man1/harbor-repo-view.1 diff --git a/doc/man-docs/harbor-repo.1 b/doc/man-docs/man1/harbor-repo.1 similarity index 100% rename from doc/man-docs/harbor-repo.1 rename to doc/man-docs/man1/harbor-repo.1 diff --git a/doc/man-docs/harbor-schedule-list.1 b/doc/man-docs/man1/harbor-schedule-list.1 similarity index 100% rename from doc/man-docs/harbor-schedule-list.1 rename to doc/man-docs/man1/harbor-schedule-list.1 diff --git a/doc/man-docs/harbor-schedule.1 b/doc/man-docs/man1/harbor-schedule.1 similarity index 100% rename from doc/man-docs/harbor-schedule.1 rename to doc/man-docs/man1/harbor-schedule.1 diff --git a/doc/man-docs/harbor-user-create.1 b/doc/man-docs/man1/harbor-user-create.1 similarity index 100% rename from doc/man-docs/harbor-user-create.1 rename to doc/man-docs/man1/harbor-user-create.1 diff --git a/doc/man-docs/harbor-user-delete.1 b/doc/man-docs/man1/harbor-user-delete.1 similarity index 100% rename from doc/man-docs/harbor-user-delete.1 rename to doc/man-docs/man1/harbor-user-delete.1 diff --git a/doc/man-docs/harbor-user-elevate.1 b/doc/man-docs/man1/harbor-user-elevate.1 similarity index 100% rename from doc/man-docs/harbor-user-elevate.1 rename to doc/man-docs/man1/harbor-user-elevate.1 diff --git a/doc/man-docs/harbor-user-list.1 b/doc/man-docs/man1/harbor-user-list.1 similarity index 100% rename from doc/man-docs/harbor-user-list.1 rename to doc/man-docs/man1/harbor-user-list.1 diff --git a/doc/man-docs/harbor-user.1 b/doc/man-docs/man1/harbor-user.1 similarity index 100% rename from doc/man-docs/harbor-user.1 rename to doc/man-docs/man1/harbor-user.1 diff --git a/doc/man-docs/harbor-version.1 b/doc/man-docs/man1/harbor-version.1 similarity index 100% rename from doc/man-docs/harbor-version.1 rename to doc/man-docs/man1/harbor-version.1 diff --git a/doc/man-docs/harbor.1 b/doc/man-docs/man1/harbor.1 similarity index 100% rename from doc/man-docs/harbor.1 rename to doc/man-docs/man1/harbor.1 diff --git a/pkg/views/artifact/list/view.go b/pkg/views/artifact/list/view.go index 3b851aee..62901de7 100644 --- a/pkg/views/artifact/list/view.go +++ b/pkg/views/artifact/list/view.go @@ -2,13 +2,14 @@ package list import ( "fmt" + "os" + "strconv" + "github.com/charmbracelet/bubbles/table" tea "github.com/charmbracelet/bubbletea" "github.com/goharbor/go-client/pkg/sdk/v2.0/models" "github.com/goharbor/harbor-cli/pkg/utils" "github.com/goharbor/harbor-cli/pkg/views/base/tablelist" - "os" - "strconv" ) var columns = []table.Column{ diff --git a/pkg/views/artifact/view/view.go b/pkg/views/artifact/view/view.go index 0ab46ae7..13288d17 100644 --- a/pkg/views/artifact/view/view.go +++ b/pkg/views/artifact/view/view.go @@ -2,13 +2,14 @@ package view import ( "fmt" + "os" + "strconv" + "github.com/charmbracelet/bubbles/table" tea "github.com/charmbracelet/bubbletea" "github.com/goharbor/go-client/pkg/sdk/v2.0/models" "github.com/goharbor/harbor-cli/pkg/utils" "github.com/goharbor/harbor-cli/pkg/views/base/tablelist" - "os" - "strconv" ) var columns = []table.Column{