-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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.
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
Deprecate multiprotocol #3833
base: master
Are you sure you want to change the base?
Deprecate multiprotocol #3833
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
Revert Core minimum version bump
7fc26c8
to
bf08819
Compare
📝 WalkthroughWalkthroughThe multiprotocol add-on has been updated to mark it as deprecated and disable automatic firmware flashing. Documentation files (CHANGELOG, README, and config) now reflect a version bump to 2.4.6, a deprecated status, and a recommendation for manual flashing. The Dockerfile and build configuration have been modified to replace the Git-based Gecko SDK retrieval with a ZIP download via curl and to remove any reference to the UNIVERSAL_SILABS_FLASHER dependency. Additionally, several service scripts related to the automatic flashing mechanism have been removed from the s6-overlay directories. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Addon
participant ManualFlasher
User->>Addon: Install/Update multiprotocol add-on
Addon-->>User: Return version 2.4.6 with deprecation notice and auto flashing disabled
Note right of Addon: Auto firmware flash scripts removed
User->>ManualFlasher: Initiate manual firmware flashing
ManualFlasher-->>User: Firmware flashing completed
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
📒 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.md
silabs-multiprotocol/README.md
silabs-multiprotocol/Dockerfile
silabs-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.md
silabs-multiprotocol/README.md
silabs-multiprotocol/Dockerfile
silabs-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.md
silabs-multiprotocol/README.md
silabs-multiprotocol/Dockerfile
silabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...
*/**(html|markdown|md)
: - Use sentence-style capitalization also in headings.
silabs-multiprotocol/CHANGELOG.md
silabs-multiprotocol/README.md
silabs-multiprotocol/Dockerfile
silabs-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.md
silabs-multiprotocol/README.md
silabs-multiprotocol/Dockerfile
silabs-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.md
silabs-multiprotocol/README.md
silabs-multiprotocol/Dockerfile
silabs-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.
Usingcurl
to download the Gecko SDK ZIP and cleaning up afterward withrm
helps to reduce unnecessary build image clutter.
@@ -1,5 +1,9 @@ | |||
# Changelog | |||
|
|||
## 2.4.6 | |||
- Formally deprecate the addon. It will continue running as usual but you should find an alternative way to run both Zigbee and Thread if you use both with the same adapter. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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
Documentation
Chores