Skip to content

feat: rename debug flag to verbose#845

Merged
craicoverflow merged 4 commits intoredhat-developer:mainfrom
craicoverflow:verbose-flag
Jul 28, 2021
Merged

feat: rename debug flag to verbose#845
craicoverflow merged 4 commits intoredhat-developer:mainfrom
craicoverflow:verbose-flag

Conversation

@craicoverflow
Copy link
Contributor

@craicoverflow craicoverflow commented Jul 27, 2021

BREAKING: The debug flag is now verbose. There is also no longer any shorthand for version.

Closes #842

Verification Steps

Run rhoas kafka list -v and it will enable verbose mode.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation change
  • Other (please specify)

Checklist

  • Documentation added for the feature
  • CI and all relevant tests are passing
  • Code Review completed
  • Verified independently by reviewer

@craicoverflow craicoverflow force-pushed the verbose-flag branch 2 times, most recently from ed23da4 to 0525dfa Compare July 27, 2021 14:36
BREAKING: The `debug` flag is now `verbose`. There is no longer any shorthand for `version`.

if err = cmdutil.CheckSurveyError(err); err != nil {
logger.Error("Error:", err)
if err != nil {
Copy link
Collaborator

@wtrocki wtrocki Jul 28, 2021

Choose a reason for hiding this comment

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

This brings patter that our commands should no longer log message when error happens but return error that is exact message of what have happened. +100. Woth to document in contributing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

None of our commands log the error, they all already return the error and let the main program handle it.

@wtrocki
Copy link
Collaborator

wtrocki commented Jul 28, 2021

@craicoverflow - I have been told that for breaking changes that can affect docs it is important to have jira and ping docs team so they can verify if the missing flag is not affecting them. I have done a quick check on the guides repo and we should be ok so leaving decision for you.

@craicoverflow
Copy link
Contributor Author

@craicoverflow - I have been told that for breaking changes that can affect docs it is important to have jira and ping docs team so they can verify if the missing flag is not affecting them. I have done a quick check on the guides repo and we should be ok so leaving decision for you.

Okay, I was unaware. I will create a JIRA.

@craicoverflow craicoverflow merged commit c2362ce into redhat-developer:main Jul 28, 2021
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.

Introduce verbose mode that is printed on every error

3 participants