Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(#426): system info utility #427

Merged
merged 1 commit into from
Sep 27, 2021

Conversation

sarsharma
Copy link
Contributor

command to show system info output for bug reports

Issue #426

Description

As mentioned in issue #426 , a single line command would be preferable to fetch system information
I added a --report flag to the version command for doing that.

Checklist

  • Add test cases to all the changes you introduce
  • Run ./script/format and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

System info can be output using a single command which can be attached to bug report

Steps to Test This Pull Request

commitizen version --report

Additional context

@sarsharma sarsharma changed the title System info utility feat(#426): system info utility Sep 25, 2021
@codecov
Copy link

codecov bot commented Sep 26, 2021

Codecov Report

Merging #427 (f8e2224) into master (ca0e4bc) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #427      +/-   ##
==========================================
+ Coverage   97.90%   97.91%   +0.01%     
==========================================
  Files          39       39              
  Lines        1384     1392       +8     
==========================================
+ Hits         1355     1363       +8     
  Misses         29       29              
Flag Coverage Δ
unittests 97.91% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
commitizen/cli.py 97.61% <ø> (ø)
commitizen/__version__.py 100.00% <100.00%> (ø)
commitizen/commands/version.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ca31452...f8e2224. Read the comment docs.

@Lee-W
Copy link
Member

Lee-W commented Sep 26, 2021

looks like the behavior of argparse has been changed on python 3.9. let me see how I can solve it

Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

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

Hi @sarthaksharma2199 , thanks for the immediate PR! I'm good with the --report flag. @woile what do you think?

One thing to note is that we'll need to wait for #430 to be merged. As a new fix on Python 3.9.7 breaks our unit test

@woile
Copy link
Member

woile commented Sep 27, 2021

Looks good to me, thank you! 🙏🏻
I think it has to be rebased in order to fix the errors.

@sarsharma sarsharma force-pushed the system-info-utility branch 2 times, most recently from fbbd552 to 7d5b80e Compare September 27, 2021 09:02
command to show system info output for bug reports

Issue commitizen-tools#426
@sarsharma
Copy link
Contributor Author

Hello, thanks for the approval @Lee-W and @woile
I had been trying to merge instead of rebase, hence the mess above.
I tried rebase this time instead, not sure if it is correct.
Please let me know if this needs to be done differently.

@Lee-W
Copy link
Member

Lee-W commented Sep 27, 2021

It looks great! Thanks! Let's merge it

@Lee-W Lee-W merged commit 609cacd into commitizen-tools:master Sep 27, 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.

3 participants