Skip to content

Commit c2ef71f

Browse files
authored
Add version bump instructions (#4)
* Add version bump instructions * Mention updating both requirements and version in manifest
1 parent c1c5667 commit c2ef71f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,15 @@ _On MacOs you will have to run above command with 'sudo' as it requires to inter
126126
[chip-controller-repl-add-on]: https://github.com/home-assistant/addons-development/tree/master/chip_controller_repl
127127
[python-chip-building]: https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/python_chip_controller_building.md
128128
[example-firmware-site]: https://nabucasa.github.io/matter-example-apps/
129+
130+
### Deploying a new version
131+
132+
1. Update Matter Server PyPI package [`pyproject.toml`](https://github.com/home-assistant-libs/python-matter-server/blob/main/pyproject.toml) with the new version.
133+
1. Update custom integration [`manifest.json`](https://github.com/home-assistant-libs/python-matter-server/blob/main/custom_components/matter_experimental/manifest.json) with the new version for both `requirements` and `version`.
134+
1. Tag a new release in this repository with the new version.
135+
136+
Updating the Matter Server add-on
137+
138+
1. Update the PyPI package version used by the Matter Server add-on by updating `MATTER_SERVER_VERSION` in the [`Dockerfile`](https://github.com/home-assistant/addons-development/blob/master/matter_server/Dockerfile)
139+
1. Bump the add-on version in [`config.yaml`](https://github.com/home-assistant/addons-development/blob/master/matter_server/config.yaml)
140+
1. Add a new entry for the new add-on version in the changelog [`CHANGELOG.md`](https://github.com/home-assistant/addons-development/blob/master/matter_server/CHANGELOG.md)

0 commit comments

Comments
 (0)