next try to cleanup addon #310
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR cleans up the NetBird Home Assistant addon by removing support for older architectures (armhf, armv7, i386), improving security by hiding sensitive setup keys in logs, enhancing documentation, and adding a comprehensive CHANGELOG. The changes streamline the addon to focus on aarch64 and amd64 architectures while improving code documentation and maintainability.
Key Changes:
- Removed support for armhf, armv7, and i386 architectures across configuration files
- Enhanced security by masking setup key values in log output
- Added comprehensive CHANGELOG.md documenting version history and changes
- Updated documentation URLs and repository references to reflect the netbirdio organization
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| netbird/rootfs/etc/s6-overlay/s6-rc.d/netbird/run | Improved security by hiding setup key in logs; enhanced DNS workaround documentation with clearer comments |
| netbird/config.yaml | Removed armhf, armv7, and i386 from supported architectures |
| netbird/build.yaml | Removed build configurations for armhf, armv7, and i386 architectures |
| netbird/DOCS.md | Updated management URL from wiretrustee.com to netbird.io; corrected contributors link to netbirdio organization |
| netbird/CHANGELOG.md | Added new CHANGELOG documenting version history, breaking changes, and improvements |
| README.md | Removed architecture badges for armhf, armv7, and i386; updated maintenance year to 2025 |
| .github/renovate.json | Updated regex pattern to match only aarch64 and amd64 architectures |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## [v0.59.13] - 2025-11-17 | ||
|
|
||
| ### Changed | ||
| - Updated to NetBird v0.59.13 |
There was a problem hiding this comment.
The CHANGELOG lists version v0.59.13, but the actual version in config.yaml (line 3) and Dockerfile (line 3) is v0.60.2. The CHANGELOG version should match the actual addon version being released.
| ## [v0.59.13] - 2025-11-17 | |
| ### Changed | |
| - Updated to NetBird v0.59.13 | |
| ## [v0.60.2] - 2025-11-17 | |
| ### Changed | |
| - Updated to NetBird v0.60.2 |
| ## [v0.54.2] - 2025-11-17 | ||
|
|
||
| ### Changed | ||
| - Updated to NetBird v0.54.2 |
There was a problem hiding this comment.
This entry lists version v0.54.2 with the same date as v0.59.13 (2025-11-17). It's unusual to have two different version releases on the same date. Additionally, this version appears older than v0.59.13, but is listed after it in the CHANGELOG. In Keep a Changelog format, newer versions should be listed first, with older versions below. Consider reorganizing these entries if v0.54.2 is actually an older release, or clarifying why both versions have the same release date.
| ## [Unreleased] | ||
|
|
||
| ### Notes | ||
| - Based on hassio-addons base image 18.2.1 |
There was a problem hiding this comment.
The CHANGELOG states the addon is "Based on hassio-addons base image 18.2.1", but the actual base image version in build.yaml is 19.0.0. This documentation should reflect the actual base image version being used.
| - Based on hassio-addons base image 18.2.1 | |
| - Based on hassio-addons base image 19.0.0 |
| [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg | ||
| [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg | ||
| [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg | ||
| [commits-shield]: https://img.shields.io/github/commit-activity/y/lfarkas/addon-netbird.svg |
There was a problem hiding this comment.
The commits-shield badge URL still references lfarkas/addon-netbird, but this is inconsistent with other repository URLs in the file that point to netbirdio/addon-netbird (see line 82 for commits link). This should be updated to match the repository organization used elsewhere in the file.
| [commits-shield]: https://img.shields.io/github/commit-activity/y/lfarkas/addon-netbird.svg | |
| [commits-shield]: https://img.shields.io/github/commit-activity/y/netbirdio/addon-netbird.svg |
| [forum]: https://community.home-assistant.io/t/repository-community-hass-io-add-ons/24705 | ||
| [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg | ||
| [issue]: https://github.com/netbirdio/addon-netbird/issues | ||
| [license-shield]: https://img.shields.io/github/license/lfarkas/addon-netbird.svg |
There was a problem hiding this comment.
The license-shield badge URL still references lfarkas/addon-netbird, but this is inconsistent with other repository URLs in the file that point to netbirdio/addon-netbird. This should be updated to match the repository organization used elsewhere in the file.
| [license-shield]: https://img.shields.io/github/license/lfarkas/addon-netbird.svg | |
| [license-shield]: https://img.shields.io/github/license/netbirdio/addon-netbird.svg |
next round to update only relevant part and no other codes