eufy-security-client-dz/docs/deployment.md

Deployment instructions

Dependency tree

There are two integrations that depend on eufy-security-ckient, one for Home Assistant and another one for Homey.

The dependency tree between all the involved repos looks like this:

• Base library (this repo): bropat/eufy-security-client
  • WebSocket server wrapper: bropat/eufy-security-ws
    • Homey integration: martinjpoppen/com.eufylife.security
    • Home Assistant Add-on: bropat/hassio-eufy-security-ws
      • Home Assistant integration fuatakgun/eufy_security

The instructions below apply only to the bropat repos.

eufy-security-client

How to deploy a new version of eufy-security-client:

1. Update all the npm dependencies.
2. Review and merge into the develop branch the PRs that should be included in the next release.
3. Merge everything from develop into master.
4. Publish a new release and tag out of the latest changes merged into master.
5. Copy the autogenerated release notes and paste them in the Changelog section of the README.md. Submit a PR with those changes and merge them.
6. Using that new release from master, publish a new eufy-security-client npm package version.

eufy-security-ws

Instructions.

hassio-eufy-security-ws

Instructions.