Upstream
/
aioesphomeapi
mirror of https://github.com/esphome/aioesphomeapi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add maintaining notes

This commit is contained in:
Otto winter 2021-06-30 17:41:45 +02:00
parent a82b6c413e
commit ce0619f963
No known key found for this signature in database
GPG Key ID: 48ED2DDB96D7682C
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
MAINTAINERS.md Normal file
View File

@ -0,0 +1,16 @@
# Maintaining Notes
Releases are automatically drafted by [release-drafter](https://github.com/release-drafter/release-drafter), the next version number is automatically computed by the labels of PRs in the release.
See also .github/release-drafter.yml, if this label is in any PR, then the version change is marked that type of version change:
- major release (+1.0.0): breaking-change, major
- minor release (+0.1.0): minor, new-feature
- patch (+0.0.1): this is the default release type
Before creating a release: Check the latest commit passes continuous integration.
When the release button on the draft is clicked, GitHub Actions will publish the release to PyPi.
After any push to the master branch, the "protoc-update" workflow is run which updates the generated python protobuf files. This is to ensure that if a contributor has a newer protoc version installed than the protobuf python package, we won't run into any issues.