Skip to content

Conversation

@Merikei
Copy link

@Merikei Merikei commented Dec 24, 2025

Fixes #5228

Summary by CodeRabbit

  • Documentation
    • Enhanced bug report form with clearer instructions for locating installed version information, directing users to the Config > Security & Updates section for both current and legacy versions.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 24, 2025

Walkthrough

Updated the bug report template's version field description to provide clear instructions for locating the WLED version across both newer and older versions. The new multiline YAML block guides users to Config > Security & Updates and references both "Installed version" (newer versions) and "Server message" (older versions) lines.

Changes

Cohort / File(s) Summary
Bug Report Template Update
.github/ISSUE_TEMPLATE/bug.yml
Updated version field description from single-line instruction to multiline YAML block with guidance for locating installed version via Config > Security & Updates, supporting both newer ("Installed version" line) and older ("Server message" line) WLED versions

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly describes the main change: updating the version description in the bug.yml file.
Linked Issues check ✅ Passed The PR updates the version field description to provide followable instructions that reference both newer (Installed version) and older (Server message) UI elements, addressing the core issue #5228.
Out of Scope Changes check ✅ Passed All changes are directly focused on fixing the bug report template's version instructions and are within the scope of issue #5228.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b821e20 and e4b0ee0.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/bug.yml
🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/bug.yml (1)

47-50: Clear improvement addressing issue #5228.

The updated instructions are much clearer and accommodate both newer versions (with "Installed version:") and older versions (with "Server message"). The YAML formatting is correct, and the use of HTML tags for visual emphasis is appropriate for GitHub issue templates. The "Installed version:" label has been verified as the correct label in the current WLED UI.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@softhack007 softhack007 self-requested a review December 24, 2025 23:19
Copy link
Member

@softhack007 softhack007 left a comment

Choose a reason for hiding this comment

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

I think the fix is correct, "server message" was changed to "Installed version" in 0.16 (main) with this commit: 7865985

As 0.16 will still need some time until officially released, I thinks it's a good idea to also have the info where to find the version and build nr in "older" releases.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cannot get WLED version with method specified in Bug Report template

2 participants