fix!: remove the --verbose flag for all related commands

cmd/notation/internal/flag/options.go

@@ -59,22 +59,18 @@ func (opts *SignerFlagOpts) ApplyFlagsToCommand(command *cobra.Command) {
 
 // LoggingFlagOpts cmd opts for logging.
 type LoggingFlagOpts struct {
-	Debug   bool
-	Verbose bool
+	Debug bool
 }
 
 // ApplyFlags applies flags to a command flag set.
 func (opts *LoggingFlagOpts) ApplyFlags(fs *pflag.FlagSet) {
 	fs.BoolVarP(&opts.Debug, "debug", "d", false, "debug mode")
-	fs.BoolVarP(&opts.Verbose, "verbose", "v", false, "verbose mode")
 }
 
 // InitializeLogger sets up the logger based on common options.
 func (opts *LoggingFlagOpts) InitializeLogger(ctx context.Context) context.Context {
 	if opts.Debug {
 		ctx = trace.WithLoggerLevel(ctx, logrus.DebugLevel)
-	} else if opts.Verbose {
-		ctx = trace.WithLoggerLevel(ctx, logrus.InfoLevel)
 	} else {
 		return ctx
 	}

specs/cmd/blob.md

@@ -92,7 +92,6 @@ Flags:
       --timestamp-root-cert string   filepath of timestamp authority root certificate
       --timestamp-url string         RFC 3161 Timestamping Authority (TSA) server URL
   -m, --user-metadata stringArray    {key}={value} pairs that are added to the signature payload
-  -v, --verbose                      verbose mode
 ```
 
 ### notation blob inspect
@@ -106,7 +105,6 @@ Usage:
 Flags:
   -o, --output string         output format, options: 'json', 'tree' (default "tree")
   -d, --debug                 debug mode
-  -v, --verbose               verbose mode
   -h, --help                  help for inspect
 ```
 
@@ -185,7 +183,6 @@ Flags:
       --policy-name string          policy name to verify against. If not provided, the global policy is used if exists
   -s  --signature string            filepath of the signature to be verified
   -m, --user-metadata stringArray   user defined {key}={value} pairs that must be present in the signature for successful verification if provided
-  -v, --verbose                     verbose mode
 ```
 
 ## Usage

specs/cmd/certificate.md

@@ -90,7 +90,6 @@ Flags:
   -h, --help           help for list
   -s, --store string   specify named store
   -t, --type string    specify trust store type, options: ca, signingAuthority, tsa
-  -v, --verbose        verbose mode
 ```
 
 ### notation certificate show
@@ -106,7 +105,6 @@ Flags:
   -h, --help           help for show
   -s, --store string   specify named store
   -t, --type string    specify trust store type, options: ca, signingAuthority, tsa
-  -v, --verbose        verbose mode
 ```
 
 ### notation certificate delete

specs/cmd/inspect.md

@@ -45,7 +45,6 @@ Flags:
   -o, --output string         output format, options: 'json', 'tree' (default "tree")
   -p, --password string       password for registry operations (default to $NOTATION_PASSWORD if not specified)
   -u, --username string       username for registry operations (default to $NOTATION_USERNAME if not specified)
-  -v, --verbose               verbose mode
 ```
 
 ## Usage

specs/cmd/key.md

@@ -39,7 +39,6 @@ Flags:
       --id string                   key id (required if --plugin is set)
       --plugin string               signing plugin name
       --plugin-config stringArray   {key}={value} pairs that are passed as it is to a plugin, refer plugin's documentation to set appropriate values
-  -v, --verbose                     verbose mode
 ```
 
 ### notation key delete
@@ -53,7 +52,6 @@ Usage:
 Flags:
   -d, --debug     debug mode
   -h, --help      help for delete
-  -v, --verbose   verbose mode
 ```
 
 ### notation key list
@@ -86,7 +84,6 @@ Flags:
   -d, --debug     debug mode
       --default   mark as default
   -h, --help      help for update
-  -v, --verbose   verbose mode
 ```
 
 ## Usage

specs/cmd/list.md

@@ -34,7 +34,6 @@ Flags:
       --oci-layout            [Experimental] list signatures stored in OCI image layout
   -p, --password string       password for registry operations (default to $NOTATION_PASSWORD if not specified)
   -u, --username string       username for registry operations (default to $NOTATION_USERNAME if not specified)
-  -v, --verbose               verbose mode
 ```
 
 ## Usage

specs/cmd/login.md

@@ -19,7 +19,6 @@ Flags:
   -p, --password string     password for registry operations (default to $NOTATION_PASSWORD if not specified)
       --password-stdin      take the password from stdin
   -u, --username string     username for registry operations (default to $NOTATION_USERNAME if not specified)
-  -v, --verbose             verbose mode
 ```
 
 ## Usage

specs/cmd/logout.md

@@ -15,7 +15,6 @@ Usage:
 Flags:
   -d, --debug     debug mode
   -h, --help      help for logout
-  -v, --verbose   verbose mode
 ```
 
 ## Usage

specs/cmd/plugin.md

@@ -53,7 +53,6 @@ Flags:
   -h, --help               help for install
       --sha256sum string   must match SHA256 of the plugin source, required when "--url" flag is set
       --url                install plugin from an HTTPS URL. The plugin download timeout is 10m0s
-  -v, --verbose            verbose mode
 
 Aliases:
   install, add
@@ -70,7 +69,6 @@ Usage:
 Flags:
   -d, --debug         debug mode
   -h, --help          help for remove
-  -v, --verbose       verbose mode
   -y, --yes           do not prompt for confirmation
 Aliases:
   uninstall, remove, rm

specs/cmd/sign.md

@@ -46,7 +46,6 @@ Flags:
        --timestamp-url string        RFC 3161 Timestamping Authority (TSA) server URL
   -u,  --username string             username for registry operations (default to $NOTATION_USERNAME if not specified)
   -m,  --user-metadata stringArray   {key}={value} pairs that are added to the signature payload
-  -v,  --verbose                     verbose mode
 ```
 
 ### Set config property for OCI image manifest

specs/cmd/verify.md

@@ -48,7 +48,6 @@ Flags:
        --scope string                [Experimental] set trust policy scope for artifact verification, required and can only be used when flag "--oci-layout" is set
   -u,  --username string             username for registry operations (default to $NOTATION_USERNAME if not specified)
   -m,  --user-metadata stringArray   user defined {key}={value} pairs that must be present in the signature for successful verification if provided
-  -v,  --verbose                     verbose mode
 ```
 
 ## Usage

specs/error-handling-guideline.md

@@ -14,7 +14,7 @@ First and foremost, make the error messages descriptive and informative. Error m
 
 Second, when necessary, it is highly suggested for Notation CLI contributors to provide recommendations for users how to resolve the problems based on the error messages they encountered. Showing descriptive words and straightforward prompt with executable commands as a potential solution is a good practice for error messages.
 
-Third, for unhandled errors you didn't expect the user to run into. For that, have a way to view full traceback information as well as full debug or verbose logs output, and instructions on how to submit a bug.
+Third, for unhandled errors you didn't expect the user to run into. For that, have a way to view full traceback information as well as full debug logs output, and instructions on how to submit a bug.
 
 Fourth, signal-to-noise ratio is crucial. The more irrelevant output you produce, the longer it's going to take the user to figure out what they did wrong. If your program produces multiple errors of the same type, consider grouping them under a single explanatory header instead of printing many similar-looking lines.
 
@@ -31,7 +31,7 @@ Last, error logs can also be useful for post-mortem debugging and can also be wr
 - Print human readable error message. If the error message is mainly from the server and varies by different servers, tell users that the error response is from server. This implies that users may need to contact server side for troubleshooting.
 - Provide specific and actionable prompt message with argument suggestion or show the example usage for reference. (e.g, Instead of showing flag or argument options is missing, please provide available argument options and guide users to `--help` to view more examples).
 - If the actionable prompt message is too long to show in the CLI output, consider guide users to Notation user manual or troubleshooting guide with the versioned permanent link.
-- If the error message is not enough for troubleshooting, guide users to use `--verbose` to print much more detailed logs.
+- If the error message is not enough for troubleshooting, guide users to use `--debug` to print much more detailed logs.
 - If server returns an error without any [message or detail](https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc.3/spec.md#error-codes), consider providing customized error logs to make it clearer. The original server logs can be displayed in debug mode.
 - As a security tool, `notation` SHOULD prompt users to stop upon verification errors. 
 

test/e2e/suite/command/inspect.go

@@ -116,7 +116,7 @@ var _ = Describe("notation inspect", func() {
 			notation.Exec("sign", "--force-referrers-tag", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("inspect", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("inspect", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(inspectSuccessfully...)
 		})
 	})
@@ -126,7 +126,7 @@ var _ = Describe("notation inspect", func() {
 			notation.Exec("sign", "--force-referrers-tag=false", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("inspect", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("inspect", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(inspectSuccessfully...)
 		})
 	})

test/e2e/suite/command/list.go

@@ -91,7 +91,7 @@ var _ = Describe("notation list", func() {
 			notation.Exec("sign", "--force-referrers-tag", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("list", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("list", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(
 					"└── application/vnd.cncf.notary.signature",
 					"└── sha256:",
@@ -104,7 +104,7 @@ var _ = Describe("notation list", func() {
 			notation.Exec("sign", "--force-referrers-tag=false", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("list", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("list", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(
 					"└── application/vnd.cncf.notary.signature",
 					"└── sha256:",

test/e2e/suite/command/sign.go

@@ -86,7 +86,7 @@ var _ = Describe("notation sign", func() {
 				MatchKeyWords(SignSuccessfully)
 
 			notation.WithDescription("verify by tag schema").
-				Exec("verify", artifact.ReferenceWithDigest(), "-v").
+				Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})
@@ -98,7 +98,7 @@ var _ = Describe("notation sign", func() {
 				MatchKeyWords(SignSuccessfully)
 
 			notation.WithDescription("verify by referrers api").
-				Exec("verify", artifact.ReferenceWithDigest(), "-v").
+				Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})
@@ -132,7 +132,7 @@ var _ = Describe("notation sign", func() {
 			// sleep to wait for expiry
 			time.Sleep(2100 * time.Millisecond)
 
-			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-v").
+			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchErrKeyWords("expiry validation failed.").
 				MatchErrKeyWords("signature verification failed for all the signatures")
 		})

test/e2e/suite/command/verify.go

@@ -29,7 +29,7 @@ var _ = Describe("notation verify", func() {
 			notation.Exec("sign", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("verify", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})
@@ -39,7 +39,7 @@ var _ = Describe("notation verify", func() {
 			notation.Exec("sign", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("verify", artifact.ReferenceWithTag(), "-v").
+			notation.Exec("verify", artifact.ReferenceWithTag(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})
@@ -69,7 +69,7 @@ var _ = Describe("notation verify", func() {
 			notation.Exec("sign", "--force-referrers-tag", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("verify", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})
@@ -79,7 +79,7 @@ var _ = Describe("notation verify", func() {
 			notation.Exec("sign", "--force-referrers-tag=false", artifact.ReferenceWithDigest()).
 				MatchKeyWords(SignSuccessfully)
 
-			notation.Exec("verify", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})
@@ -163,7 +163,7 @@ var _ = Describe("notation verify", func() {
 				MatchKeyWords(SignSuccessfully)
 
 			vhost.UpdateEnv(map[string]string{"NOTATION_CONFIG": "/not/exist"})
-			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-v").
+			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchErrKeyWords("trust policy is not present")
 		})
 	})
@@ -174,7 +174,7 @@ var _ = Describe("notation verify", func() {
 				MatchKeyWords(SignSuccessfully)
 
 			vhost.UpdateEnv(map[string]string{"NOTATION_CONFIG": vhost.AbsolutePath(NotationDirName)})
-			notation.Exec("verify", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})
@@ -185,7 +185,7 @@ var _ = Describe("notation verify", func() {
 				MatchKeyWords(SignSuccessfully)
 
 			vhost.UpdateEnv(map[string]string{"NOTATION_CACHE": vhost.AbsolutePath(NotationDirName)})
-			notation.Exec("verify", artifact.ReferenceWithDigest(), "-v").
+			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
 				MatchKeyWords(VerifySuccessfully)
 		})
 	})

test/e2e/suite/plugin/install.go

@@ -67,14 +67,14 @@ var _ = Describe("notation plugin install", func() {
 
 	It("with zip bomb single file exceeds 256 MiB size limit in zip format", func() {
 		Host(nil, func(notation *utils.ExecOpts, _ *Artifact, vhost *utils.VirtualHost) {
-			notation.ExpectFailure().Exec("plugin", "install", "--file", filepath.Join(NotationE2EMaliciousPluginArchivePath, "large_file_zip.zip"), "-v").
+			notation.ExpectFailure().Exec("plugin", "install", "--file", filepath.Join(NotationE2EMaliciousPluginArchivePath, "large_file_zip.zip"), "-d").
 				MatchErrContent("Error: plugin installation failed: total file size reached the 256 MiB size limit\n")
 		})
 	})
 
 	It("with zip bomb single file exceeds 256 MiB size limit in tar.gz format", func() {
 		Host(nil, func(notation *utils.ExecOpts, _ *Artifact, vhost *utils.VirtualHost) {
-			notation.ExpectFailure().Exec("plugin", "install", "--file", filepath.Join(NotationE2EMaliciousPluginArchivePath, "large_file_tarGz.tar.gz"), "-v").
+			notation.ExpectFailure().Exec("plugin", "install", "--file", filepath.Join(NotationE2EMaliciousPluginArchivePath, "large_file_tarGz.tar.gz"), "-d").
 				MatchErrContent("Error: plugin installation failed: total file size reached the 256 MiB size limit\n")
 		})
 	})
@@ -97,21 +97,21 @@ var _ = Describe("notation plugin install", func() {
 				Fail(fmt.Sprintf("failed to write file %s: %v", targetPath, err))
 			}
 
-			notation.ExpectFailure().Exec("plugin", "install", "--file", targetPath, "-v").
+			notation.ExpectFailure().Exec("plugin", "install", "--file", targetPath).
 				MatchErrContent("Error: plugin installation failed: total file size reached the 256 MiB size limit\n")
 		})
 	})
 
 	It("with zip slip", func() {
 		Host(nil, func(notation *utils.ExecOpts, _ *Artifact, vhost *utils.VirtualHost) {
-			notation.ExpectFailure().Exec("plugin", "install", "--file", filepath.Join(NotationE2EMaliciousPluginArchivePath, "zip_slip.zip"), "-v").
+			notation.ExpectFailure().Exec("plugin", "install", "--file", filepath.Join(NotationE2EMaliciousPluginArchivePath, "zip_slip.zip"), "-d").
 				MatchErrContent("Error: plugin installation failed: file name in zip cannot contain '..', but found \"../../../../../../../../tmp/evil.txt\"\n")
 		})
 	})
 
 	It("with valid plugin file path", func() {
 		Host(nil, func(notation *utils.ExecOpts, _ *Artifact, vhost *utils.VirtualHost) {
-			notation.Exec("plugin", "install", "--file", NotationE2EPluginTarGzPath, "-v").
+			notation.Exec("plugin", "install", "--file", NotationE2EPluginTarGzPath, "-d").
 				MatchContent("Successfully installed plugin e2e-plugin, version 1.0.0\n")
 		})
 	})
@@ -135,7 +135,7 @@ var _ = Describe("notation plugin install", func() {
 
 	It("with plugin already installed but force install", func() {
 		Host(nil, func(notation *utils.ExecOpts, _ *Artifact, vhost *utils.VirtualHost) {
-			notation.Exec("plugin", "install", "--file", NotationE2EPluginTarGzPath, "-v").
+			notation.Exec("plugin", "install", "--file", NotationE2EPluginTarGzPath, "-d").
 				MatchContent("Successfully installed plugin e2e-plugin, version 1.0.0\n")
 
 			notation.Exec("plugin", "install", "--file", NotationE2EPluginTarGzPath, "--force").