Update issue templates #5818

spirillen · 2024-07-22T13:27:11Z

Changes

Updated the issue templates to support the new yaml format.

This is done to help submitter to type in tedious information such as OS, Browser, Versions as these as easily can be picked from a dropdown optional list.

All fields should have unique identifies following the simple camelCase syntax to make it easier to extract the information via the GH API.

I've kept the old issue styled .md files for reference, and they should be deleted before any merge actually happens.

Please enjoy my small giveback to an awesome project.

Issues

Replacing the tedious of typing the standard values of OS, Browser, Versions

Important

Before actual merging the old issue templates in markdown format need to be deleted or renamed to eg. .old

These have solely been kept as reference of contents in the new yaml styled files

This is done to help submitter to type in tedious information such as OS, Browser, Versions as these as easily can be picked from a dropdown optional list.

All fields should have uniq identifies following the simple camellCase syntax to make it easier to extract the information via the GH API.

I've kept the old issue styled .md files for reference, and they should be deleted before any merge actually happens.

Please enjoy my small giveback to an awsome project.

TODO before merge

Remove old markdown issue templates
- Delete the META template?
Adapt current versions, at time of merge

Updated the issue templates to support the new yaml format. This is done to help submitter to type in tedious information such as OS, Browser, Versions as these as easily can be picked from a dropdown optional list. All fields should have uniq identifies following the simple calCase syntax to make it easier to extract the information via the GH API. I've kept the old issue styled .md files for reference, and they should be deleted before any merge actually happens. Please enjoy my small giveback to an awsome project.

thornbill · 2024-08-13T20:51:01Z

Thanks for the contribution!

I haven't reviewed this in depth yet, but we recently updated the server issue template so we should probably make sure this is generally similar. Refs: jellyfin/jellyfin#11135

I would also remove versions that do not exist currently. (We will probably automate updating the versions in the template at some point.)
I think we can just remove the meta issue template... I think it pretty much only gets (ab)used to not follow the normal issue format.

sonarqubecloud · 2024-08-16T09:05:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

jellyfin-bot · 2024-08-16T09:09:00Z

Cloudflare Pages deployment

Latest commit	`3ec4591`
Status	✅ Deployed!
Preview URL	https://e5d385a5.jellyfin-web.pages.dev
Type	🔀 Preview

View build logs

spirillen · 2024-08-16T09:26:06Z

Hi @thornbill

I have added a todo list to have these comments in mind before merging. This also means I did not change anything yet, as you mentioned your self, your comments are at first look.

.github/ISSUE_TEMPLATE/1-bug-report.yml

oddstr13 · 2024-12-21T02:08:55Z

.github/ISSUE_TEMPLATE/1-bug-report.yml

+        - 10.10.4
+        - 10.10.5
+        - 10.10.6
+        - 10.10.7
+        - 10.10.8
+        - 10.10.9


Suggested change

- 10.10.4

- 10.10.5

- 10.10.6

- 10.10.7

- 10.10.8

- 10.10.9

Additionally, I would suggest using an input field instead of a dropdown. I personally dislike needing to specify "Other" in a separate field. While I understand it's a GitHub limitation, it's not ideal.

I'd pass this to the Jellyfin-Web crew to decide. Template wise this is totaly okay though!

I would suggest using an input field instead of a dropdown

The choice in the dropdown, is to help avoiding against typo's and tedious typing, that just as well "pre typed" in a dropdown.

The dropdown of versions should of course be maintained by the release script

In my opinion, the lack of a dedicated "other" field will break automations, as it won't be possible to reliably extract the contents of this value.

All custom builds from source will be categorized as "other," and all custom browsers will also be labeled as "other." Furthermore, every release will require an update to the dropdown, even if this becomes automated in the future.

If the dropdown included a writable "other" field, the situation would be different, but unfortunately, this is a technical limitation from GitHub.

While the user can specify the value in another field, automations won’t be able to find it. Additionally, this approach adds extra effort, as the user would need to select "other," scroll back up, and manually enter the version information.

@BotBlake I see your point and can follow your POV as wellm Yet not fully convinced it will be a problem.

Chosing to let the question open for other comments, before choosing to fiddle more with this part

I would vote for just using an input also. Our experience shows that unless we have some automation to update the version options, they will quickly get out of date. 😅

🤷🏻‍♂️ You do realize, this is the point, for which I made this template??

Why not make a option for major version.x.x, that opens for code errors?

oddstr13 · 2024-12-21T02:10:05Z

.github/ISSUE_TEMPLATE/2-playback-issue.yml

+      description: Please paste any ffprobe or MediaInfo logs.
+      render: bash


Suggested change

description: Please paste any ffprobe or MediaInfo logs.

render: bash

description: Please include any ffprobe or MediaInfo logs.

Afaik, when adding the render option, GitHub will no longer allow a File Upload as a submission in that Text Field.
In the end its a matter of choice, if the team rather wants a bash Codeblock, or a bare Textfield where Users Potentialy Upload logfiles to.

In my personal Oppinion, rendering to bash might the better choice.

The third option is to add a upload log file(s) here

oddstr13 · 2024-12-21T02:11:03Z

.github/ISSUE_TEMPLATE/2-playback-issue.yml

+        - 10.10.3
+        - 10.10.4
+        - 10.10.5
+        - 10.10.6
+        - 10.10.7
+        - 10.10.8
+        - 10.10.9


Suggested change

- 10.10.3

- 10.10.4

- 10.10.5

- 10.10.6

- 10.10.7

- 10.10.8

- 10.10.9

- 10.10.3

Same comment as https://github.com/jellyfin/jellyfin-web/pull/5818/files#r1894567432

oddstr13 · 2024-12-21T02:12:41Z

.github/ISSUE_TEMPLATE/1-bug-report.yml

+
+      render: bash
+


Suggested change

render: bash

Can change the render to logs... I've added the rendering to encapsulate any text that might convert into undesirably links

oddstr13 · 2024-12-21T02:17:04Z

.github/ISSUE_TEMPLATE/1-bug-report.yml

+projects:
+  - jellyfin/jellyfin-web


Suggested change

projects:

- jellyfin/jellyfin-web

won't work for users without write access to the project in question, at least according to the docs

Leaving for now, as this might change in future

.github/ISSUE_TEMPLATE/2-playback-issue.yml

Accepted Co-authored-by: Odd Stråbø <[email protected]>

Accepted, Typo Co-authored-by: Odd Stråbø <[email protected]>

BotBlake · 2024-12-21T06:40:28Z

.github/ISSUE_TEMPLATE/1-bug-report.yml

+      options:
+        - Firefox-ESR
+        - Firefox
+        - Chrome based (Chromium, Edge)


Chromium based.
Chrome is based on Chromium. Edge is based on Chromium.
https://en.wikipedia.org/wiki/Chromium_(web_browser)

Words mixed up.

Super, will fix the wording.

@BotBlake

Thanks to @BotBlake in jellyfin#5818 (comment) to notice the mix Signed-off-by: spirillen <[email protected]>

sonarqubecloud · 2024-12-21T09:15:19Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

spirillen requested a review from a team as a code owner July 22, 2024 13:27

Merge branch 'master' into spirillen-issueReports-1

ee57bd7

oddstr13 reviewed Dec 21, 2024

View reviewed changes

oddstr13 changed the title ~~issue template update~~ Update issue templates Dec 21, 2024

spirillen and others added 3 commits December 21, 2024 05:50

Update .github/ISSUE_TEMPLATE/1-bug-report.yml

0887764

Accepted Co-authored-by: Odd Stråbø <[email protected]>

Update .github/ISSUE_TEMPLATE/1-bug-report.yml

b281bfe

Accepted Co-authored-by: Odd Stråbø <[email protected]>

Update .github/ISSUE_TEMPLATE/2-playback-issue.yml

c00e842

Accepted, Typo Co-authored-by: Odd Stråbø <[email protected]>

spirillen deployed to Preview December 21, 2024 05:56 — with GitHub Actions View deployment

BotBlake reviewed Dec 21, 2024

View reviewed changes

word exchange 1-bug-report.yml

281d9f8

Thanks to @BotBlake in jellyfin#5818 (comment) to notice the mix Signed-off-by: spirillen <[email protected]>

spirillen deployed to Preview December 21, 2024 08:43 — with GitHub Actions View deployment

Merge branch 'jellyfin:master' into spirillen-issueReports-1

3ec4591

spirillen deployed to Preview December 21, 2024 09:18 — with GitHub Actions View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update issue templates #5818

Update issue templates #5818

spirillen commented Jul 22, 2024 •

edited

Loading

thornbill commented Aug 13, 2024

sonarqubecloud bot commented Aug 16, 2024

jellyfin-bot commented Aug 16, 2024 •

edited

Loading

spirillen commented Aug 16, 2024

oddstr13 Dec 21, 2024

BotBlake Dec 21, 2024

spirillen Dec 21, 2024

BotBlake Dec 21, 2024

spirillen Dec 21, 2024

thornbill Jan 6, 2025

spirillen Jan 6, 2025

oddstr13 Dec 21, 2024

BotBlake Dec 21, 2024

spirillen Dec 21, 2024

oddstr13 Dec 21, 2024

spirillen Dec 21, 2024

oddstr13 Dec 21, 2024

spirillen Dec 21, 2024

oddstr13 Dec 21, 2024

spirillen Dec 21, 2024

BotBlake Dec 21, 2024

spirillen Dec 21, 2024

sonarqubecloud bot commented Dec 21, 2024

		description: Please paste any ffprobe or MediaInfo logs.
		render: bash

	description: Please paste any ffprobe or MediaInfo logs.
	render: bash
	description: Please include any ffprobe or MediaInfo logs.

-        - 10.10.3
-        - 10.10.4
-        - 10.10.5
-        - 10.10.6
-        - 10.10.7
-        - 10.10.8
-        - 10.10.9
+        - 10.10.3

Update issue templates #5818

Are you sure you want to change the base?

Update issue templates #5818

Conversation

spirillen commented Jul 22, 2024 • edited Loading

Changes

Issues

Important

TODO before merge

thornbill commented Aug 13, 2024

sonarqubecloud bot commented Aug 16, 2024

Quality Gate passed

jellyfin-bot commented Aug 16, 2024 • edited Loading

Cloudflare Pages deployment

spirillen commented Aug 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 21, 2024

Quality Gate passed

spirillen commented Jul 22, 2024 •

edited

Loading

jellyfin-bot commented Aug 16, 2024 •

edited

Loading