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. Run sh scrtips/cut_release <version> to update the version and create a PR
3. Review and merge into the develop branch the PRs that should be included in the next release.
4. Merge everything from develop into master.
5. Publish a new release and tag out of the latest changes merged into master.
6. Generate the changelog entries by running sh scripts/generate_changelog.sh <last_release_pr_number>, where <last_release_pr_number> is the PR number of the previous release. This will output formatted entries grouped by Feature, Fix, and Chore. Paste the output into the Changelog section of the README.md under the new version heading.
7. Submit a PR with those changes and merge them.
8. Using that new release from master, publish a new eufy-security-client npm package version. but using npm publish locally

Next steps:

1. Release a new version of bropat/eufy-security-ws
2. Release a new version of bropat/hassio-eufy-security-ws

eufy-security-ws

Instructions.

hassio-eufy-security-ws

Instructions.