feat(cli): Add examples to --help output for remaining "argocd repocr…

…eds" cmds (argoproj#15846) Signed-off-by: Michele Caci <michele.caci@gmail.com>
tesla59 · Dec 16, 2023 · 7fa78ac · 7fa78ac
1 parent 0d80743
commit 7fa78ac
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 0 deletions.
diff --git a/cmd/argocd/commands/repocreds.go b/cmd/argocd/commands/repocreds.go
@@ -17,13 +17,24 @@ import (
 	"github.com/argoproj/argo-cd/v2/util/errors"
 	"github.com/argoproj/argo-cd/v2/util/git"
 	"github.com/argoproj/argo-cd/v2/util/io"
+	"github.com/argoproj/argo-cd/v2/util/templates"
 )
 
 // NewRepoCredsCommand returns a new instance of an `argocd repocreds` command
 func NewRepoCredsCommand(clientOpts *argocdclient.ClientOptions) *cobra.Command {
 	var command = &cobra.Command{
 		Use:   "repocreds",
 		Short: "Manage repository connection parameters",
+		Example: templates.Examples(`
+			# Add credentials with user/pass authentication to use for all repositories under the specified URL
+			argocd repocreds add URL --username USERNAME --password PASSWORD
+
+			# List all the configured repository credentials
+			argocd repocreds list
+
+			# Remove credentials for the repositories with speficied URL
+			argocd repocreds rm URL
+		`),
 		Run: func(c *cobra.Command, args []string) {
 			c.HelpFunc()(c, args)
 			os.Exit(1)
@@ -184,6 +195,10 @@ func NewRepoCredsRemoveCommand(clientOpts *argocdclient.ClientOptions) *cobra.Co
 	var command = &cobra.Command{
 		Use:   "rm CREDSURL",
 		Short: "Remove repository credentials",
+		Example: templates.Examples(`
+			# Remove credentials for the repositories with URL https://git.example.com/repos
+			argocd repocreds rm https://git.example.com/repos/
+		`),
 		Run: func(c *cobra.Command, args []string) {
 			ctx := c.Context()
 
@@ -231,6 +246,13 @@ func NewRepoCredsListCommand(clientOpts *argocdclient.ClientOptions) *cobra.Comm
 	var command = &cobra.Command{
 		Use:   "list",
 		Short: "List configured repository credentials",
+		Example: templates.Examples(`
+			# List all the configured repository credentials
+			argocd repocreds list
+
+			# List all the configured repository credentials in json format
+			argocd repocreds list -o json
+		`),
 		Run: func(c *cobra.Command, args []string) {
 			ctx := c.Context()
 

diff --git a/docs/user-guide/commands/argocd_repocreds.md b/docs/user-guide/commands/argocd_repocreds.md
@@ -8,6 +8,19 @@ Manage repository connection parameters
 argocd repocreds [flags]
 ```
 
+### Examples
+
+```
+  # Add credentials with user/pass authentication to use for all repositories under the specified URL
+  argocd repocreds add URL --username USERNAME --password PASSWORD
+  
+  # List all the configured repository credentials
+  argocd repocreds list
+  
+  # Remove credentials for the repositories with speficied URL
+  argocd repocreds rm URL
+```
+
 ### Options
 
 ```

diff --git a/docs/user-guide/commands/argocd_repocreds_list.md b/docs/user-guide/commands/argocd_repocreds_list.md
@@ -8,6 +8,16 @@ List configured repository credentials
 argocd repocreds list [flags]
 ```
 
+### Examples
+
+```
+  # List all the configured repository credentials
+  argocd repocreds list
+  
+  # List all the configured repository credentials in json format
+  argocd repocreds list -o json
+```
+
 ### Options
 
 ```

diff --git a/docs/user-guide/commands/argocd_repocreds_rm.md b/docs/user-guide/commands/argocd_repocreds_rm.md
@@ -8,6 +8,13 @@ Remove repository credentials
 argocd repocreds rm CREDSURL [flags]
 ```
 
+### Examples
+
+```
+  # Remove credentials for the repositories with URL https://git.example.com/repos
+  argocd repocreds rm https://git.example.com/repos/
+```
+
 ### Options
 
 ```