diff options
| author | Raphael | 2022-04-02 10:33:12 -0400 |
|---|---|---|
| committer | GitHub | 2022-04-02 16:33:12 +0200 |
| commit | 723c7e9aec1fb5cb2c40514993be9131fbc229ee (patch) | |
| tree | d2fabda3b0484ece9ab5081c2de2ff162659a4e8 /CONTRIBUTING.md | |
| parent | 2b6c2b98e09ab6eed11c14bc142d6caece769ab8 (diff) | |
| download | unexpected-keyboard-723c7e9aec1fb5cb2c40514993be9131fbc229ee.tar.gz unexpected-keyboard-723c7e9aec1fb5cb2c40514993be9131fbc229ee.zip | |
Upgrade CI workflow (#111)
* Cache dependencies on CI workflow
* Use available fontforge version for CI action
Avoid a dirty OS upgrade to get a newer version of FontForge,
use what is available at Ubuntu 20.04
* Upgrade CI Workflow
By using an appimage of FontForge, it's easier to install the latest version, to cache it, and there is no extra dependencies clashes with Ubuntu 20.04
* Make paths for fontforge absolute in makefile
It's necessary because fontforge is an AppImage and requires it
* Improve cache step on CI
wget don't download a duplicate if file already exists
* Generate base64 ascii encoded debug keystore
That can be used to transfer the keystore to a Github Secret
* Restore debug.keystore from github secrets
Get the asc encoded keystore from github secrets,
and decode it back to a bynary file inside the CI run.
* Cleanup redundant lines and add explanation comment
* runs-on ubuntu-latest
Co-authored-by: Jules Aguillon <jules@j3s.fr>
* add *.keystore.asc to .gitignore
* Clean up lines, adjust documentation
* use CURDIR automatic makefile variable
Co-authored-by: Jules Aguillon <jules@j3s.fr>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5caaa7e..d36ec97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,24 @@ make If the build succeed, the debug apk is located in `_build/juloo.keyboard2.debug.apk`. +## Using the local debug.keystore on the Github CI actions + +It's possible to save the local debug.keystore into a github secret, so the same keystore is utilized to build the debug apk in the CI github actions. +Doing this, they wil have the same signature, thus the debug apk can be updated without having to uninstall it first. + +After you sucessfully run `make`, (thus a debug.keystore exists) you can use this second command to generate a base64 stringified version of it + +```sh +cd _build +gpg -c --armor --pinentry-mode loopback --passphrase debug0 --yes "debug.keystore" +``` + +A file will be generated inside the local `_build/` folder, called `debug.keystore.asc` + +You can copy the content of this file, and with that, paste it into a new github secret in your repo settings. + +The secret must be named `DEBUG_KEYSTORE` + ## Debugging on your phone First [Enable adb debugging on your device](https://developer.android.com/studio/command-line/adb#Enabling). |