Remove backticks from Report a Bug scripts #127801

Alaska · 2024-09-18T14:41:57+02:00

Alaska commented

2024-09-18 14:41:57 +02:00

Removing backticks allows Gitea to automatically create and display
links between commit hashes and the actual commit on the bug report.

Removing backticks allows Gitea to automatically create and display links between commit hashes and the actual commit on the bug report.

Alaska added 1 commit 2024-09-18 14:42:00 +02:00

Remove backticks from report a bug scripts 71ed9cf6f1

Alaska added this to the Triaging project 2024-09-18 14:42:06 +02:00

Iliya Katushenock requested review from Bastien Montagne 2024-09-18 14:42:33 +02:00

Alaska commented

2024-09-18 14:48:28 +02:00

I'm not sure who to add as a reviewer. If you believe someone else is better suited as a reviewer, feel free to add them.

This change was requested by @mont29

Benefit of the change:

Creates automatical links to hashes.

Disadvantage of the change:

Results in increased noise in the commit notes section.
- In case you don't know. The Blender bot script adds notes on commits mentioning where it was referenced from. There wil be increased "noise" in these notes, from all the bug reports made on specific hashes.

I'm not sure who to add as a reviewer. If you believe someone else is better suited as a reviewer, feel free to add them. This change was requested by @mont29 --- Benefit of the change: - Creates automatical links to hashes. Disadvantage of the change: - Results in increased noise in the commit notes section. - In case you don't know. The Blender bot script adds notes on commits mentioning where it was referenced from. There wil be increased "noise" in these notes, from all the bug reports made on specific hashes.

Alaska requested review from Thomas Dinges 2024-09-18 14:48:57 +02:00

Alaska requested review from Philipp Oeser 2024-09-18 14:48:58 +02:00

Hans Goudey commented

2024-09-18 15:32:27 +02:00

Personally I find the reference noise in the notes more annoying than having to copy & paste a hash. Not sure if this was discussed by others though.

Alaska commented

2024-09-18 15:40:47 +02:00

Not sure if this was discussed by others though.

To my knowledge there hasn't been a discussion about this outside of a quick note from Bastien in the Triaging Blender chat channel:

Bastien:
small note regarding commits in gitea reports/comments: Please do not put the hashes inside back-ticks ``, this prevents gitea from detecting them as commits and automatically generate the links to them.

Alaska:
Just for clarification.
If a user selects Help -> Report a bug from Blender. You get "Broken: ... hash_in_ticks". Is that fine?
But when a triager modifies it and says "Broken: Caused by 4.3 hash" you don't want the ticks? Or do you not want the ticks in any situation?

Bastien:
I'd rather not have the ticks in any situation

This last statement lead to me opening this PR.

> Not sure if this was discussed by others though. To my knowledge there hasn't been a discussion about this outside of a quick note from Bastien in the Triaging Blender chat channel: > *Bastien:* > small note regarding commits in gitea reports/comments: Please do not put the hashes inside back-ticks ``, this prevents gitea from detecting them as commits and automatically generate the links to them. > *Alaska:* > Just for clarification. > If a user selects Help -> Report a bug from Blender. You get "Broken: ... `hash_in_ticks`". Is that fine? > But when a triager modifies it and says "Broken: Caused by 4.3 `hash`" you don't want the ticks? Or do you not want the ticks in any situation? > *Bastien:* > I'd rather not have the ticks in any situation This last statement lead to me opening this PR.

Bastien Montagne commented

2024-09-18 15:44:46 +02:00

I find the copy/paste fairly annoying TBH :)

Results in increased noise in the commit notes section.

Not sure I understand what is the issue here, can someone give (or link to) an example?

I find the copy/paste fairly annoying TBH :) > Results in increased noise in the commit notes section. Not sure I understand what is the issue here, can someone give (or link to) an example?

Alaska commented

2024-09-18 16:00:21 +02:00

27680118db

Underneath the commit message in the Gitea UI is a section for notes. At the moment this is primarily used by the blender-bot to note when the commit is referenced somewhere.

If we remove backticks from the hash from the Report a Bug button, then unrelated notes will be added to commits simply because someone made a bug report from a build with that specific hash.

27680118dbdf37fd086554786555cdd9763fa13a Underneath the commit message in the Gitea UI is a section for notes. At the moment this is primarily used by the blender-bot to note when the commit is referenced somewhere. If we remove backticks from the hash from the `Report a Bug` button, then unrelated notes will be added to commits simply because someone made a bug report from a build with that specific hash.

Example of note.png

32 KiB

Bastien Montagne commented

2024-09-18 16:22:35 +02:00

Aaaah I see :( , thanks.

Then indeed, I think it would be better to not edit the report template.

But is there agreement that once triaging/dev team has identified an actual issue-related commit, they should still use unticked hashes then?

Aaaah I see :( , thanks. Then indeed, I think it would be better to not edit the report template. But is there agreement that once triaging/dev team has identified an actual issue-related commit, they should still use unticked hashes then?

👍 1

Alaska commented

2024-09-18 16:42:55 +02:00

But is there agreement that once triaging/dev team has identified an actual issue-related commit, they should still use unticked hashes then?

I think it's a good idea and I will personally aim to do that.

> But is there agreement that once triaging/dev team has identified an actual issue-related commit, they should still use unticked hashes then? I think it's a good idea and I will personally aim to do that.

👍 1

Alaska closed this pull request

2024-09-18 16:42:58 +02:00

Alaska deleted branch remove-backticks

2024-09-18 16:43:17 +02:00

Philipp Oeser commented

2024-09-19 09:30:59 +02:00

test comment for an edit of a comment that has one with backticks (e.g. a2a03252c6 ) that are then edited away at a later point

test comment for an edit of a comment that has one with backticks (e.g. a2a03252c6cf44f6c42ef474cd5d164d3ca3af4a ) that are then edited away at a later point

Pull request closed

This pull request cannot be reopened because the branch was deleted.

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Remove backticks from Report a Bug scripts #127801

Pull request closed