meshtastic/website/docs/developers/publish.md

55 lines
1.3 KiB
Markdown
Raw Normal View History

---
2021-11-16 20:05:19 -08:00
id: publish
title: Publishing Meshtastic
sidebar_label: Publishing Meshtastic
---
This document is a WIP.
If youd like to do real releases with your changes, the procedure is:
## Device
2021-11-16 19:52:00 -08:00
* 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
2021-11-16 19:52:00 -08:00
TBD
## iOS
TBD
## Python
### Pre-requistes
2021-11-16 19:52:00 -08:00
* Python Packages
* * pip3 install pdoc3
* * pip3 install pygatt
* * pip3 install pandoc
* * pip install twine
* https://pandoc.org/installing.html
* nanopb 0.4.4 installed
### Instructions
* update the proto submodule
2021-11-16 19:52:00 -08:00
* bump the version in setup.py
* 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.
:::note
You need permissions in the github project to make a build
:::