Skip to content

Update version description in bug.yml #5229

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.

Sign up for GitHub

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

Merged
softhack007 merged 1 commit into from
Jan 5, 2026
Merged

Update version description in bug.yml #5229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ body:
id: version
attributes:
label: What version of WLED?
description: You can find this in by going to Config -> Security & Updates -> Scroll to Bottom. Copy and paste the entire line after "Server message"
description: |-
Find this by going to <kbd><samp>⚙️ Config</samp></kbd> → <kbd><samp>Security & Updates</samp></kbd> → Scroll to Bottom.
Copy link
Member

@softhack007 softhack007 Dec 25, 2025

Choose a reason for hiding this comment

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

@coderabbitai what do the tags and do? Is adding HTML tags allowed for issue field descriptions?

Copy link
Contributor

@coderabbitai coderabbitai bot Dec 26, 2025

Choose a reason for hiding this comment

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

🧩 Analysis chain

🌐 Web query:

GitHub issue templates YAML HTML support description field

💡 Result:

Short answer: The top-level description in YAML issue forms/templates is plain text (not arbitrary HTML). Use the template/body fields (markdown or markdown-type form elements) for richer formatting. See GitHub's issue-forms docs and the example frontmatter showing description as a simple string and guidance to put formatted content in body fields. [1][2][3]

Sources

  • GitHub: Configuring issue templates / Issue forms (example uses a plain string description). [1]
  • GitHub: Manually creating an issue template — YAML front-matter (about/description keys). [2]
  • Community gist / cheat-sheet noting description is a short string (≤200 chars) for YAML forms. [3]

🌐 Web query:

GitHub issue forms input field description HTML markdown support

💡 Result:

Short answer: Input-field descriptions in GitHub issue forms accept Markdown (e.g., links) but not arbitrary HTML. Use the form schema's markdown element or a textarea field (which supports the same Markdown as an issue body) for richer/longer formatted content. [1][2]

Sources:

  • GitHub "Syntax for issue forms" (example uses a Markdown link in description). [1]
  • Guide / docs explaining markdown and textarea behavior in issue forms. [2]

🌐 Web query:

GitHub issue forms HTML tags kbd samp rendering

💡 Result:

Yes — GitHub's markdown sanitizer allows and , and they render (typically) like inline code/monospace when content is shown in issues, PRs and comments. [1][2][3]

Sources:

  • GitHub HTML whitelist (html-pipeline) showing kbd and samp allowed. [1]
  • Stack Overflow summary referencing the whitelist. [2]
  • Gist listing allowed GFM tags and noting kbd/samp render like code. [3]

@softhack007 Great questions!

What the tags do:

  • <kbd> represents keyboard input and typically renders styled like a keyboard key (often with a subtle border/shadow effect)
  • <samp> represents sample output or text from a computer program and renders in monospace font

Are they allowed?
Yes, HTML tags are supported in GitHub issue form descriptions. GitHub's markdown sanitizer includes <kbd> and <samp> in its whitelist of allowed HTML tags, so they will render properly in the issue template.

In this specific case:

  • <kbd><samp>⚙️ Config</samp></kbd> will display "⚙️ Config" styled as both a keyboard key and monospace text
  • <samp>Installed version: </samp> and <samp>Server message</samp> will display in monospace font to indicate these are literal text strings users should look for in the UI

These tags improve the clarity of the instructions by visually distinguishing UI elements and literal text from the surrounding description text.

Copy link
Contributor Author

@Merikei Merikei Dec 26, 2025

Choose a reason for hiding this comment

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

What they do together:

When the kbd element contains a samp element, it represents input based on system output, for example invoking a menu item.

— WHATWG (Web Hypertext Application Technology Working Group)

Copy link
Contributor

@coderabbitai coderabbitai bot Dec 26, 2025

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

Copy and paste the rest of the line that begins “<samp>Installed version: </samp>”,
or, for older versions, the entire line after “<samp>Server message</samp>”.
placeholder: "e.g. WLED 0.13.1 (build 2203150)"
validations:
required: true
Expand Down