meshtastic/docs/developers/publish.mdx

111 lines
3.4 KiB
Plaintext
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
2022-03-08 04:12:46 -08:00
- Update protobufs
```shell
cd proto
git checkout master && git pull
cd ..
git add proto
git commit -m "updating proto submodule to latest"
run bin/regen-protos.sh
```
2022-03-08 04:12:46 -08:00
- edit version.properties to set release version
- commit and push (or merge) to root of repo - this should cause GitHub to start a release build (see the CI actions)
- edit the draft release text and click publish
### Update Protobufs
## Android
2021-12-10 20:17:31 -08:00
### Pre-requisites
2022-03-08 04:12:46 -08:00
- Add repository secrets
- - KEYSTORE_FILENAME
- - - name of the .jks
- - KEYSTORE
- - - we will convert the .jks to base64
- - - openssl base64 < filename.jks | tr -d '\n' | tee filename.txt
- - KEYSTORE_PROPERTIES
- - - storePassword=nononononono
keyPassword=nononononono
keyAlias=upload
storeFile=nononononono.jks
2021-11-16 19:52:00 -08:00
2021-12-10 20:17:31 -08:00
### Instructions - Automated
2022-03-08 04:12:46 -08:00
- Update protobufs
- Go to Actions / Make Release / Run Workflow
- Pick the Releases branch
- Enter the version found in app/gradle.build
2022-02-12 15:05:34 -08:00
2021-11-16 19:52:00 -08:00
## iOS
TBD
2022-02-12 15:05:34 -08:00
## Meshtastic-flasher
A `meshtastic-flasher` release consists of publishing the release to PyPi https://pypi.org/project/meshtastic-flasher/ as well as producing single-executable files that are downloadable from Github https://github.com/meshtastic/Meshtastic-gui-installer/releases.
### Instructions - automated
2022-02-12 15:05:34 -08:00
2022-03-08 04:12:46 -08:00
- Go to Actions / Make Release / Run Workflow https://github.com/meshtastic/Meshtastic-gui-installer/actions/workflows/release.yml
- Draft & Publish release https://github.com/meshtastic/Meshtastic-gui-installer/releases
2022-02-12 15:05:34 -08:00
## Python
2022-01-26 12:24:19 -08:00
A python release consists of publishing the release to PyPi https://pypi.org/project/meshtastic/ as well as producing single-executable files that are downloadable from Github https://github.com/meshtastic/Meshtastic-python/releases.
### Pre-requisites
2021-11-16 19:52:00 -08:00
2022-01-26 12:24:19 -08:00
No pre-requisites are needed locally to make a release. All builds are done via Github Actions currently.
To test/validate, you will need to run:
```
pip3 install -r requirements.txt
pip install .
```
### Instructions
2022-03-08 04:12:46 -08:00
- Update protobufs by running the "Update protobufs" workflow in Actions: https://github.com/meshtastic/Meshtastic-python/actions/workflows/update_protobufs.yml
2022-01-26 12:24:19 -08:00
2022-03-08 04:12:46 -08:00
- run the "smoke1" test (optional):
2022-01-26 12:24:19 -08:00
connect one device to the serial port and run:
```
pytest -m smoke1
```
2022-03-08 04:12:46 -08:00
- run unit tests: `pytest` (optional)
2022-01-26 12:24:19 -08:00
2022-03-08 04:12:46 -08:00
- run bin/test-release.sh (optional)
2022-01-26 12:24:19 -08:00
2022-03-08 04:12:46 -08:00
- Run the "Make Release" workflow in Actions: https://github.com/meshtastic/Meshtastic-python/actions/workflows/release.yml
2022-01-26 12:24:19 -08:00
2022-03-08 04:12:46 -08:00
- After the "Make Release" is done, go into Releases: https://github.com/meshtastic/Meshtastic-python/releases There should be a draft. Add the title, update the "What's Changed" (Tip: Click on the "Auto-generate release notes" button.). Uncheck the "This is a pre-release" (if applicable).
:::note
You need permissions in the GitHub project to make a build
2022-01-02 22:53:45 -08:00
:::
2022-03-08 04:12:46 -08:00
## Web
Releases are automatically generated for every commit as per out [CI](https://github.com/meshtastic/meshtastic-web/blob/master/.github/workflows/main.yml). This performs two actions:
1. Generates a perpetually updated [GitHub release](https://github.com/meshtastic/meshtastic-web/releases/tag/latest) with an accompanying `build.tar` that a automatically get's pulled by the firmware CI at build time.
2. A hosted version is deployed to [client.meshtastic.org](https://client.meshtastic.org).