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

Use GitHub yaml templates for ICE, Docs and Diagnostics tickets #106831

Merged
merged 1 commit into from
Jan 14, 2023

Conversation

estebank
Copy link
Contributor

@estebank estebank commented Jan 14, 2023

The GitHub yaml templates allow us to define HTML forms with validation for issue templates, instead of the current markdown based templates which only let us introduce text into the user editable text area. The form lets us make some fields mandatory, as well as add text that won't pollute the user's text and titles that won't be interfered with by enterprising users.

@rustbot
Copy link
Collaborator

rustbot commented Jan 14, 2023

r? @Mark-Simulacrum

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 14, 2023
@estebank estebank marked this pull request as ready for review January 14, 2023 01:17
@estebank estebank changed the title Use GitHub yaml templates for ICE and Diagnostics tickets Use GitHub yaml templates for ICE, Docs and Diagnostics tickets Jan 14, 2023
@estebank
Copy link
Contributor Author

estebank commented Jan 14, 2023

@Mark-Simulacrum
Copy link
Member

Not opposed to trying this! I know required form inputs can be annoying when filing issues though, but we already have alternatives and users can always opt-out, so it's probably OK.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jan 14, 2023

📌 Commit a1614d0 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 14, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 14, 2023
…lacrum

Use GitHub yaml templates for ICE, Docs and Diagnostics tickets

The GitHub yaml templates allow us to define HTML forms with validation for issue templates, instead of the current markdown based templates which only let us introduce text into the user editable text area. The form lets us make some fields mandatory, as well as add text that won't pollute the user's text and titles that won't be interfered with by enterprising users.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 14, 2023
…lacrum

Use GitHub yaml templates for ICE, Docs and Diagnostics tickets

The GitHub yaml templates allow us to define HTML forms with validation for issue templates, instead of the current markdown based templates which only let us introduce text into the user editable text area. The form lets us make some fields mandatory, as well as add text that won't pollute the user's text and titles that won't be interfered with by enterprising users.
Copy link
Contributor

@mejrs mejrs left a comment

Choose a reason for hiding this comment

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

I generally prefer the placeholders in these fields to be more suggestive, do you mind if I send a PR myself? 🙂

id: code
attributes:
label: Code
description: Please provide code or a link to a repository that can reproduce the problem
Copy link
Contributor

@mejrs mejrs Jan 14, 2023

Choose a reason for hiding this comment

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

Suggested change
description: Please provide code or a link to a repository that can reproduce the problem
description: Please provide code, [playground[(https://play.rust-lang.org/) link or a link to a repository that can reproduce the problem

I'd like to nudge people to reproduce on the playground :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes! Please send a follow up PR!

bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 14, 2023
…iaskrgr

Rollup of 10 pull requests

Successful merges:

 - rust-lang#106046 (Fix mir-opt tests for big-endian platforms)
 - rust-lang#106470 (tidy: Don't include wasm32 in compiler dependency check)
 - rust-lang#106566 (Emit a single error for contiguous sequences of unknown tokens)
 - rust-lang#106644 (Update the wasi-libc used for the wasm32-wasi target)
 - rust-lang#106665 (Add note when `FnPtr` vs. `FnDef` impl trait)
 - rust-lang#106752 (Emit a hint for bad call return types due to generic arguments)
 - rust-lang#106788 (Tweak E0599 and elaborate_predicates)
 - rust-lang#106831 (Use GitHub yaml templates for ICE, Docs and Diagnostics tickets)
 - rust-lang#106846 (Improve some comments and names in parser)
 - rust-lang#106848 (Fix wrong path in triage bot autolabel for wg-trait-solver-refactor)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 2e30e52 into rust-lang:master Jan 14, 2023
@rustbot rustbot added this to the 1.68.0 milestone Jan 14, 2023
@albertlarsan68
Copy link
Member

albertlarsan68 commented Jan 14, 2023

Hello,
On GitHub Mobile, the new categories are down the list and need to be filled in a browser.
I think this should be reverted until GitHub Mobile supports them natively.

@estebank
Copy link
Contributor Author

@albertlarsan68 Does GitHub Mobile not open an embedded browser for them to work? If so, that's quite a bad user experience :-/

This should be a consideration, but I am hesitant to revert the changes for ICEs in particular because I'm failing to picture a situation where someone encounters one in a device where the user is also needing to file the report using GitHub Mobile.

@albertlarsan68
Copy link
Member

It seems like it is one of the few cases where it doesn't work, while for other links it opens them in an embedded browser.

@estebank
Copy link
Contributor Author

@albertlarsan68 does it at least give a reasonable error? I want to figure out how quickly we need to come to a decision for changes.

@albertlarsan68
Copy link
Member

albertlarsan68 commented Jan 14, 2023

It is not an error, just that it opens in the "external" browser, and not an embedded browser.
And the new emplacement for those items becomes between the links to {U,I}RLO and the security policy.
Here is a (scrolled) screenshot of the "Create an issue" page:
Screenshot_20230114_194312_GitHub

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 31, 2023
… r=Mark-Simulacrum

Include both md and yaml ICE ticket templates

* Existing compilers link to the md version
* The YAML version field for the backtrace *doesn't let us paste a full backtrace*
* We will need the YAML version in order to be able to submit reports once we start storing the backtrace to disk

Follow up to rust-lang#106831. Reaction to rust-lang#106874, which made me realize that *really* long backtraces are rejected by GitHub Forms. A single backtrace won't hit this, but ICEs sometimes compound.
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 31, 2023
… r=Mark-Simulacrum

Include both md and yaml ICE ticket templates

* Existing compilers link to the md version
* The YAML version field for the backtrace *doesn't let us paste a full backtrace*
* We will need the YAML version in order to be able to submit reports once we start storing the backtrace to disk

Follow up to rust-lang#106831. Reaction to rust-lang#106874, which made me realize that *really* long backtraces are rejected by GitHub Forms. A single backtrace won't hit this, but ICEs sometimes compound.
@estebank estebank deleted the tickets_yaml branch November 9, 2023 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants