mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 06:04:22 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update to clarify the steps to update protobufs

Browse source
This commit is contained in:
Jm Casler 2021-11-29 21:59:22 -08:00
parent 8a27b5b423
commit b290008f4b
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
website/docs/developers/publish.md
View file

@ -10,17 +10,19 @@ If you’d like to do ‘real’ releases with your changes, the procedure is:
## Device
* Update protobufs
* * cd proto
* * git checkout master && git pull
* * cd ..
* * git add proto
* * git commit -m "updating proto submodule to latest"
* run bin/regen-protos.sh
* edit version.properties and check it into the root project
* run bin/promote-release.sh - this should cause github to start a release build (see the CI actions)
* edit the draft release text and click publish
### Update Protobufs
* cd proto
* git checkout master && git pull
* cd ..
* git add proto
* git commit -m "updating proto submodule to latest"
## Android
@ -44,8 +46,16 @@ TBD
### Instructions
* update the proto submodule
* Update protobufs
* * cd proto
* * git checkout master && git pull
* * cd ..
* * git add proto
* * git commit -m "updating proto submodule to latest"
* run bin/regen-protos.sh
* bump the version in setup.py
* run bin/test-release.sh
* * Ensure no errors.
* run bin/upload-release.sh
I usually just edit setup.py to bump the version number, then run "bin/upload-release.sh" (though you should use bin/test-release.sh for the first time - which is just a dry deploy to the pypi test server). This script does the build (including new docs - which will end up in the git checkin) and upload to pypi. Then I do a git commit/push and tag wit the version number.