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

Add print_env.sh to improve bug reporting #874

Merged
merged 5 commits into from
Jan 30, 2023

Conversation

jarmak-nv
Copy link
Contributor

Description

Closes #774

  • This PR adds the print_env.sh file from cudf to get specific environment information during bug reports.
  • The bug report template is also updated, requesting reporters to run the script and include its results.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@jarmak-nv jarmak-nv requested a review from a team as a code owner January 25, 2023 13:14
@jarmak-nv jarmak-nv added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Jan 25, 2023
@codecov-commenter
Copy link

Codecov Report

Base: 92.55% // Head: 92.55% // No change to project coverage 👍

Coverage data is based on head (89f9d79) compared to base (a614265).
Patch has no changes to coverable lines.

Additional details and impacted files
@@              Coverage Diff              @@
##           branch-23.02     #874   +/-   ##
=============================================
  Coverage         92.55%   92.55%           
=============================================
  Files                24       24           
  Lines              1008     1008           
=============================================
  Hits                933      933           
  Misses               75       75           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@ajschmidt8 ajschmidt8 left a comment

Choose a reason for hiding this comment

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

Welcome back, @jarmak-nv!

Left a quick question on this PR.

Comment on lines 78 to 80
+ Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ If method of install is Docker, provide `docker pull` & `docker run` commands used
+ print_env.sh output
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
+ Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ If method of install is Docker, provide `docker pull` & `docker run` commands used
+ print_env.sh output
Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
If method of install is Docker, provide `docker pull` & `docker run` commands used
print_env.sh output

Are these + characters intended?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you!

Yeah they were intended just as a bullet between the lines because you can't actually do markdown in the placeholder text to make a real bulleted list.

Not married to them though!

Copy link
Member

Choose a reason for hiding this comment

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

No problem. just checking! Didn't know if it was a copy/paste error.

Copy link
Member

Choose a reason for hiding this comment

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

I think the bullets are useful. However print_env.sh output is not very instructive. I think it should at least be a link to the .sh file in the repo.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
+ Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ If method of install is Docker, provide `docker pull` & `docker run` commands used
+ print_env.sh output
+ Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ If method of install is Docker, provide `docker pull` & `docker run` commands used
+ Run [print_env.sh](https://github.com/rapidsai/cuspatial/blob/main/print_env.sh) and paste in the output.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right now, in the placeholder text the link wouldn't actually work since placeholder text doesn't support markdown.

I've added in a link in the description and referenced it in the placeholder, I think that should be good. Thoughts @harrism?

Copy link
Member

@harrism harrism left a comment

Choose a reason for hiding this comment

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

Thanks Ben!

Comment on lines 78 to 80
+ Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ If method of install is Docker, provide `docker pull` & `docker run` commands used
+ print_env.sh output
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
+ Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ If method of install is Docker, provide `docker pull` & `docker run` commands used
+ print_env.sh output
+ Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ If method of install is Docker, provide `docker pull` & `docker run` commands used
+ Run [print_env.sh](https://github.com/rapidsai/cuspatial/blob/main/print_env.sh) and paste in the output.

@harrism
Copy link
Member

harrism commented Jan 30, 2023

/merge

@rapids-bot rapids-bot bot merged commit f4a4380 into rapidsai:branch-23.02 Jan 30, 2023
@jarmak-nv jarmak-nv deleted the add-printenv branch January 31, 2023 01:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[FEA] Add print_env.sh to cuSpatial
5 participants