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

Make system information for issue reports single-line #77574

Merged

Conversation

MJacred
Copy link
Contributor

@MJacred MJacred commented May 28, 2023

Context: Before #65902, the Bug Report Template had System Info as a single-line input field. Web browsers only cache values for auto-completion for input fields, not text areas.
Using auto-completion is especially useful for contributors who commit daily/weekly, whose system specs shouldn't change that often to warrant using the copy button in the editor every single time.

This PR

  • makes the Bug Report Template field an input type again, and
  • adjusts the "Copy System Info" button to create a compact single-line output to fit the input field.

See short exchange here: #65902 (comment)

@Calinou, @akien-mga: What do you think?


Editor

image

Output Format Now

Godot v4.1.dev (bc19b5abf) - Ubuntu 20.04.6 LTS (Focal Fossa) - Vulkan (Forward+) - dedicated NVIDIA GeForce GTX 970 (nvidia; 510.108.03) - Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz (16 Threads)

Output Format Before

  • OS: Ubuntu 20.04.5 LTS (Focal Fossa)
  • Godot Version: 4.0.beta.custom_build
  • Rendering Driver: vulkan
  • Rendering Method: Forward+
  • Graphics Card: NVIDIA GeForce GTX 970 (dedicated)
  • Graphics Card Driver: nvidia, version 510.85.02
  • CPU: Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz (16 Threads)

@MJacred MJacred requested a review from a team as a code owner May 28, 2023 13:22
@Calinou Calinou added this to the 4.1 milestone May 28, 2023
@fire fire changed the title Make copied system info and its target field in Bug Report Template single-line Godot Engine button to copy systeminfo and make the Github Bug Report Template single-line May 28, 2023
@akien-mga
Copy link
Member

I still foresee one issue which may defeat the purpose of making it a single line field again: the Godot version number in the system info (with hash) means that this field should basically be regenerated from Godot for each issue you make, so using a past entry would be inaccurate.

I guess folks who want to use this convenience can manually remove the Godot version from their system info, since it's duplicated from the Godot version field in the issue template anyway.

@MJacred
Copy link
Contributor Author

MJacred commented May 29, 2023 via email

@Zireael07
Copy link
Contributor

@MJacred I think there can be only one on Github?

@MJacred
Copy link
Contributor Author

MJacred commented May 29, 2023 via email

@YuriSizov
Copy link
Contributor

There can be many issue templates, but there is not much practical reason to have a different one for custom builds.

@YuriSizov YuriSizov changed the title Godot Engine button to copy systeminfo and make the Github Bug Report Template single-line Make system information for issue reports single-line May 29, 2023
@YuriSizov
Copy link
Contributor

I guess folks who want to use this convenience can manually remove the Godot version from their system info, since it's duplicated from the Godot version field in the issue template anyway.

To make this easier we can put Godot version as the first item in the copied string.

@MJacred
Copy link
Contributor Author

MJacred commented May 29, 2023 via email

Additionally:
* for custom builds, add commit hash
* added a tooltip to help mitigate potential/understandable confusion whether the single-line output might be a bug
* prettify driver name
@MJacred MJacred force-pushed the editor/system_info_single_line branch from bc19b5a to ca1ee31 Compare May 29, 2023 20:20
@MJacred
Copy link
Contributor Author

MJacred commented May 29, 2023

put Godot version as the first item in the copied string.

@YuriSizov: Done

@akien-mga akien-mga merged commit 60871fd into godotengine:master May 30, 2023
@akien-mga
Copy link
Member

Thanks!

@YuriSizov
Copy link
Contributor

Cherry-picked for 4.0.4. The entire quadruple: #58518, #65902, #77574, #77929

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants