mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update publish.md

Browse source
This commit is contained in:
Sacha Weatherstone 2022-03-08 23:12:46 +11:00
parent 53f236bca3
commit 7db2726eb2
1 changed files with 35 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
docs/developers/publish.md
View file

@ -10,9 +10,9 @@ If you’d like to do ‘real’ releases with your changes, the procedure is:
## Device ## Device
* Update protobufs - Update protobufs
``` ```bash
cd proto cd proto
git checkout master && git pull git checkout master && git pull
cd .. cd ..
@ -21,36 +21,34 @@ git commit -m "updating proto submodule to latest"
run bin/regen-protos.sh run bin/regen-protos.sh
``` ```
* edit version.properties to set release version - 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) - 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 - edit the draft release text and click publish
### Update Protobufs ### Update Protobufs
## Android ## Android
### Pre-requisites ### Pre-requisites
* Add repository secrets - Add repository secrets
* * KEYSTORE_FILENAME - - KEYSTORE_FILENAME
* * * name of the .jks - - - name of the .jks
* * KEYSTORE - - KEYSTORE
* * * we will convert the .jks to base64 - - - we will convert the .jks to base64
* * * openssl base64 < filename.jks | tr -d '\n' | tee filename.txt - - - openssl base64 < filename.jks | tr -d '\n' | tee filename.txt
* * KEYSTORE_PROPERTIES - - KEYSTORE_PROPERTIES
* * * storePassword=nononononono - - - storePassword=nononononono
keyPassword=nononononono keyPassword=nononononono
keyAlias=upload keyAlias=upload
storeFile=nononononono.jks storeFile=nononononono.jks
### Instructions - Automated ### Instructions - Automated
* Update protobufs - Update protobufs
* Go to Actions / Make Release / Run Workflow - Go to Actions / Make Release / Run Workflow
* Pick the Releases branch - Pick the Releases branch
* Enter the version found in app/gradle.build - Enter the version found in app/gradle.build
## iOS ## iOS
@ -62,8 +60,8 @@ A `meshtastic-flasher` release consists of publishing the release to PyPi https:
### Instructions - automated ### Instructions - automated
* Go to Actions / Make Release / Run Workflow https://github.com/meshtastic/Meshtastic-gui-installer/actions/workflows/release.yml - 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 - Draft & Publish release https://github.com/meshtastic/Meshtastic-gui-installer/releases
## Python ## Python
@ -82,9 +80,9 @@ pip install .
### Instructions ### Instructions
* Update protobufs by running the "Update protobufs" workflow in Actions: https://github.com/meshtastic/Meshtastic-python/actions/workflows/update_protobufs.yml - Update protobufs by running the "Update protobufs" workflow in Actions: https://github.com/meshtastic/Meshtastic-python/actions/workflows/update_protobufs.yml
* run the "smoke1" test (optional): - run the "smoke1" test (optional):
connect one device to the serial port and run: connect one device to the serial port and run:
@ -92,14 +90,21 @@ connect one device to the serial port and run:
pytest -m smoke1 pytest -m smoke1
``` ```
* run unit tests: `pytest` (optional) - run unit tests: `pytest` (optional)
* run bin/test-release.sh (optional) - run bin/test-release.sh (optional)
* Run the "Make Release" workflow in Actions: https://github.com/meshtastic/Meshtastic-python/actions/workflows/release.yml - Run the "Make Release" workflow in Actions: https://github.com/meshtastic/Meshtastic-python/actions/workflows/release.yml
* 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). - 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 :::note
You need permissions in the GitHub project to make a build You need permissions in the GitHub project to make a build
::: :::
## 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).