Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

40 lines (33 loc) · 2.38 KB
Raw

Setting up

  1. Git clone this project into your add-ons folder
  2. Remove the image key from hassio-zigbee2mqtt/zigbee2mqtt-edge/config.json to enable local builds.
  3. Add back "image": "dwelch2101/zigbee2mqtt-edge-{arch}" to zigbee2mqtt-edge/config.json after you're done.

Upgrading the Zigbee2mqtt version

So you want to bump the zigbee2mqtt version because I'm too slow. Here's how:

  1. Change the version number in zigbee2mqtt/config.json: "version": "$NEW_VERSION"
  2. Update zigbee2mqtt/CHANGELOG.md
  3. Commit the changes to dev branch
  4. Publish a new "Release". Very important you specify Target: dev. Example
Tag version: v1.17.1  @ Target: dev
Release title: v1.17.1
  1. When the pipelines finish the build create a PR to master
  2. Use Squash and Merge option

Developing against the Home Assistant container

When you want to check the impact of developing work, e.g. adjusting devices in zigbee-herdsman-converters, you need access to the add-on container in Home Assistant. Here's how:

🚨 Following these directions will make your Home Assistant system more prone to misconfiguration (by yourself) to the extent of rendering it completely useless, so only touch what you're confident to and "know what you do".

  1. install the Portainer addon from the Add-on store
  2. Make sure to disable its Protection mode: image
  3. Start Portainer and Open Web UI
  4. in the left menu,
    1. head to Settings > section Hidden Containers and remove io.hass.type: addon
    2. go to Containers, addon_[…]_zigbee2mqtt, Console, Connect
  5. ℹ️ the location of zigbee-herdsman-converters for example is /app/node_modules/zigbee-herdsman-converters
  6. make your adjustments by copying or vi'ing
  7. Still in portainer, go back to the add-on's container and Restart

⚠️ Note that restarting the add-on via Supervisor or further down the stack will revert the file changes.

After work is done, don't forget to clean up and reintroduce the safety measures:

  1. re-add the filter io.hass.type: addon for Hidden Containers
  2. re-activate the "Protection mode" of the Portainer