Skip to content

Comments

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

Merged
JeyJeyGao merged 3 commits intonotaryproject:mainfrom
JeyJeyGao:fix/deprecate_verbose
May 13, 2025
Merged

fix!: remove the --verbose flag for all related commands#1276
JeyJeyGao merged 3 commits intonotaryproject:mainfrom
JeyJeyGao:fix/deprecate_verbose

Conversation

@JeyJeyGao
Copy link
Contributor

Pending on #1260

This PR removed the --verbose flag support as proposed in #1260.

Resolve part of #1247

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao requested a review from a user May 12, 2025 07:09
@JeyJeyGao JeyJeyGao requested a review from Copilot May 12, 2025 07:10
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes support for the --verbose flag in favor of the existing --debug flag. The changes update the documentation for error handling and command usage, and remove the verbose flag references from both CLI specifications and internal flag configuration.

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

File Description
specs/error-handling-guideline.md Updated error troubleshooting guidance to refer to --debug instead of --verbose.
specs/cmd/*.md Removed the --verbose flag from various command specifications.
cmd/notation/internal/flag/options.go Eliminated the verbose flag and its usage from logger configuration.
Comments suppressed due to low confidence (2)

specs/error-handling-guideline.md:33

  • The update to use '--debug' instead of '--verbose' is clear; please verify that all related help text and user guidance across the commands are updated accordingly.
- If the error message is not enough for troubleshooting, guide users to use `--verbose` to print much more detailed logs.

cmd/notation/internal/flag/options.go:62

  • Ensure that the removal of the '--verbose' flag and its corresponding logger level configuration does not impact existing behavior or backward compatibility; also, update any related tests and documentation.
fs.BoolVarP(&opts.Verbose, "verbose", "v", false, "verbose mode")

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao changed the title fix: remove the --verbose flag fix!: remove the --verbose flag May 12, 2025
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao changed the title fix!: remove the --verbose flag fix!: remove the --verbose flag for all related commands May 12, 2025
@codecov
Copy link

codecov bot commented May 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.95%. Comparing base (c68425f) to head (3de3013).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1276      +/-   ##
==========================================
- Coverage   76.96%   76.95%   -0.02%     
==========================================
  Files          68       68              
  Lines        3847     3844       -3     
==========================================
- Hits         2961     2958       -3     
  Misses        682      682              
  Partials      204      204              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JeyJeyGao JeyJeyGao merged commit 27dbb16 into notaryproject:main May 13, 2025
7 checks passed
@JeyJeyGao JeyJeyGao deleted the fix/deprecate_verbose branch May 13, 2025 05:29
FeynmanZhou pushed a commit to FeynmanZhou/notation that referenced this pull request May 15, 2025
…ct#1276)

Pending on notaryproject#1260

This PR removed the `--verbose` flag support as proposed in
notaryproject#1260.

Resolve part of notaryproject#1247

---------

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants