Docs: update README

This commit is contained in:
Dorian Zedler 2022-08-04 17:32:24 +02:00
parent d39a03c789
commit 8a961d7e5e
Signed by: dorian
GPG key ID: 989DE36109AFA354

View file

@ -8,6 +8,10 @@ The following settings changes this plugin's behavior.
* qmake_arguments (optional) additional arguments for qmake.
* androiddeployqt_arguments (optional) additional arguments for androiddeployqt.
* src_dir (optional) the path to the source directory
* android_keystore_path (optional) the path to the android_keystore file.
* android_keystore_alias (required, if android_keystore_path is set) the keystore alias.
* android_keystore_store_pass (optional, secret recommended) the password for the keystore.
Below is an example `.drone.yml` that uses this plugin.
@ -20,15 +24,20 @@ steps:
image: itsblue.dev/plugins/qt-android
pull: if-not-exists
settings:
qmake_attributes: "CONFIG+=release"
androiddeployqt_attributes: "--aab"
qmake_arguments: "CONFIG+=release"
androiddeployqt_arguments: "--aab"
src_dir: "."
android_keystore_path: "android_release.keystore"
android_keystore_alias: "foo"
android_keystore_store_pass:
from_secret: android_keystore_store_pass
```
# Building
Build the plugin image:
```text
```bash
docker build -t itsblue.dev/plugins/qt-android -f Dockerfile .
```
@ -36,14 +45,18 @@ docker build -t itsblue.dev/plugins/qt-android -f Dockerfile .
Execute the plugin from your current working directory:
```text
```bash
docker run --rm \
-e DRONE_COMMIT_SHA=8f51ad7884c5eb69c11d260a31da7a745e6b78e2 \
-e DRONE_COMMIT_BRANCH=master \
-e DRONE_BUILD_NUMBER=43 \
-e DRONE_BUILD_STATUS=success \
-e PLUGIN_QMAKE_ARGUMENTS="CONFIG+=release"
-e PLUGIN_ANDROIDDEPLOYQT_ARGUMENTS="--aab"
-e PLUGIN_QMAKE_ARGUMENTS="CONFIG+=release" \
-e PLUGIN_ANDROIDDEPLOYQT_ARGUMENTS="--aab" \
-e PLUGIN_SRC_DIR="." \
-e PLUGIN_ANDROID_KEYSTORE_PATH="android_release.keystore" \
-e PLUGIN_ANDROID_KEYSTORE_ALIAS="foo" \
-e PLUGIN_ANDROID_KEYSTORE_STORE_PASS="strong_password" \
-w /drone/src \
-v $(pwd):/drone/src \
itsblue.dev/plugins/qt-android