Deprecate multiprotocol - #3833
Conversation
There was a problem hiding this comment.
Copilot reviewed 8 out of 12 changed files in this pull request and generated no suggestions.
Files not reviewed (4)
- silabs-multiprotocol/Dockerfile: Language not supported
- silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/type: Language not supported
- silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/up: Language not supported
- silabs-multiprotocol/rootfs/etc/s6-overlay/scripts/universal-silabs-flasher-up: Language not supported
3956c20 to
b6abdb1
Compare
|
@agners Have you run into this before? This image no longer builds on armhf because of a |
Hm, yeah, lately the whole QEMU based builds started too be rather unreliable, especially for aarch64. We run into that problem also in the Docker base images (see home-assistant/docker-base#294). What did help so far is using the ubuntu-22.04 runners instead. This would affect all add-on, but that is fine from my point of view. |
7fc26c8 to
bf08819
Compare
📝 WalkthroughWalkthroughThe changes deprecate the Silicon Labs Multiprotocol add-on by updating documentation, configuration, and metadata to reflect its deprecated status. The Dockerfile is modified to update Java installation, improve SLC CLI installation and verification, and switch Gecko SDK retrieval to a release ZIP download. The build configuration updates the flasher version. Changes
Sequence Diagram(s)sequenceDiagram
participant Dockerfile
participant AzulRepo
participant SiliconLabs
participant GitHub
Dockerfile->>AzulRepo: Add GPG key & repo, install zulu21-jre
Dockerfile->>SiliconLabs: Download SLC CLI ZIP
Dockerfile->>Dockerfile: Unzip & verify SLC CLI
Dockerfile->>GitHub: Download Gecko SDK ZIP
Dockerfile->>Dockerfile: Unzip Gecko SDK, cleanup
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📥 CommitsReviewing files that changed from the base of the PR and between bf0881928e1342d5942900c0c1a4266b8a77a644 and 61572fe. 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (3)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
silabs-multiprotocol/README.md (1)
5-5: Review markdown header formatting.
The header currently escapes the square brackets (\[DEPRECATED\]). Consider removing the backslashes so that the text renders naturally as [DEPRECATED] for clarity and consistency with standard Markdown practices.silabs-multiprotocol/CHANGELOG.md (1)
4-4: Enhance sentence clarity.
Insert a comma before but in the sentence “It will continue running as usual but you should…” to improve readability and adhere to proper punctuation rules.🧰 Tools
🪛 LanguageTool
[uncategorized] ~4-~4: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...addon. It will continue running as usual but you should find an alternative way to r...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 13c92fd and bf0881928e1342d5942900c0c1a4266b8a77a644.
📒 Files selected for processing (8)
silabs-multiprotocol/CHANGELOG.md(1 hunks)silabs-multiprotocol/Dockerfile(1 hunks)silabs-multiprotocol/README.md(1 hunks)silabs-multiprotocol/build.yaml(0 hunks)silabs-multiprotocol/config.yaml(2 hunks)silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/type(0 hunks)silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/up(0 hunks)silabs-multiprotocol/rootfs/etc/s6-overlay/scripts/universal-silabs-flasher-up(0 hunks)
💤 Files with no reviewable changes (4)
- silabs-multiprotocol/build.yaml
- silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/type
- silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/up
- silabs-multiprotocol/rootfs/etc/s6-overlay/scripts/universal-silabs-flasher-up
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
silabs-multiprotocol/CHANGELOG.mdsilabs-multiprotocol/README.mdsilabs-multiprotocol/Dockerfilesilabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
silabs-multiprotocol/CHANGELOG.mdsilabs-multiprotocol/README.mdsilabs-multiprotocol/Dockerfilesilabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: - Be brief in your replies and don...
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
silabs-multiprotocol/CHANGELOG.mdsilabs-multiprotocol/README.mdsilabs-multiprotocol/Dockerfilesilabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
silabs-multiprotocol/CHANGELOG.mdsilabs-multiprotocol/README.mdsilabs-multiprotocol/Dockerfilesilabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: do not comment on HTML used for ic...
*/**(html|markdown|md): do not comment on HTML used for icons
silabs-multiprotocol/CHANGELOG.mdsilabs-multiprotocol/README.mdsilabs-multiprotocol/Dockerfilesilabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
silabs-multiprotocol/CHANGELOG.mdsilabs-multiprotocol/README.mdsilabs-multiprotocol/Dockerfilesilabs-multiprotocol/config.yaml
🪛 LanguageTool
silabs-multiprotocol/CHANGELOG.md
[uncategorized] ~4-~4: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...addon. It will continue running as usual but you should find an alternative way to r...
(COMMA_COMPOUND_SENTENCE)
🔇 Additional comments (7)
silabs-multiprotocol/README.md (1)
1-4: Deprecation notice is clear and actionable.
The caution block clearly informs users that multiprotocol support is discontinued and directs them to the appropriate migration instructions.silabs-multiprotocol/config.yaml (3)
2-2: Version update verified.
The version is updated to 2.4.6, which aligns with the deprecation change.
4-4: Add-on naming correctly reflects deprecation.
The name "[Deprecated] Silicon Labs Multiprotocol" clearly communicates the add-on’s status.
53-53: Stage update confirms deprecation status.
Setting the stage to deprecated ensures that users are aware of the add-on’s status in the ecosystem.silabs-multiprotocol/CHANGELOG.md (1)
3-6: Changelog entry documents deprecation and flashing changes.
The new 2.4.6 entry clearly explains that the add-on is deprecated and that automatic firmware flashing is disabled in favor of manual flashing options.🧰 Tools
🪛 LanguageTool
[uncategorized] ~4-~4: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...addon. It will continue running as usual but you should find an alternative way to r...(COMMA_COMPOUND_SENTENCE)
silabs-multiprotocol/Dockerfile (2)
1-10: Verify removal of unused build argument.
The Dockerfile no longer referencesARG UNIVERSAL_SILABS_FLASHER, which is consistent with the deprecation of multiprotocol functionality. Confirm that no lingering references to this argument exist in any associated build scripts.
110-112: Streamlined Gecko SDK retrieval is efficient.
Usingcurlto download the Gecko SDK ZIP and cleaning up afterward withrmhelps to reduce unnecessary build image clutter.
There was a problem hiding this comment.
The changelog will be shown quite prominently for most users on upgrade. Ideally we use this to link to instructions how users can move their installation to Zigbee/Thread only.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Revert Core minimum version bump
This reverts commit 8874194bf604f716c5f3441cbc25b12fbb22b58d.
bd396f4 to
c9891a8
Compare
agners
left a comment
agners
left a comment
There was a problem hiding this comment.
I've tested the new build on my end, and things seem to still work. LGTM.
|
This PR won't cause any new version to be released and just update the addon store listing, right? I think it's good to merge in that case. |
It will rebuild the image (and push it under the same tag), but it won't show up as a new version for users (only update the listing). So we had to make it build again, in case someone installs it (despite it being deprecated). |
I've removed the ability of the addon to flash multiprotocol firmware and have updated the README to reflect the addon's formal deprecation. It hasn't received any updates in about a year now and will not receive any for the foreseeable future, as we are focusing on improving our individual Zigbee and Thread firmwares.
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores