Skip to content

Commit cf516a2

Browse files
committed
docs
1 parent 58b38bf commit cf516a2

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,19 @@ pre-commit install
7373

7474
All checks should pass before you push your code.
7575
Merge requests with violations are likely to be ignored until they are fully compliant.
76+
77+
### Release process
78+
79+
Create a release on Github with a new tag in the format `v1.0.0`.
80+
The [release Github Actions workflow](.github/workflows/release.yml) will take care of the rest.
81+
It will set the version in pyproject.toml, build, run tests, and publish to pypi.
82+
83+
The bumped version is not committed back to the repo to simplify the workflow.
84+
85+
Don't forget to set the new version as dependency in both requirements.txt AND manifest.json on the HA integration!
86+
87+
## Support
88+
89+
This library and the related [Home Assistant integration](https://github.com/enovates/home-assistant-enovates) are provided AS-IS, and without warranty.
90+
Support may be provided on the repository's [Issue tracker](https://github.com/enovates/enovates-modbus/issues) on a best-effort basis only.
91+
Please do not file support requests about this library via the Enovates website.

0 commit comments

Comments
 (0)