quickjs-tart

commit 5efdacee97c72891950d71879131da238875cf81
parent 8c51db56099d2fbd587140c70aa0fbcbb399def3
Author: Iván Ávalos <avalos@disroot.org>
Date:   Tue,  7 Feb 2023 10:38:36 -0600

Added README.md to docker-android/

Diffstat:
A
docker-android/README.md
 | 
44
++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 44 insertions(+), 0 deletions(-)
diff --git a/docker-android/README.md b/docker-android/README.md
@@ -0,0 +1,44 @@
+# Docker build instructions
+
+At Taler, we're deeply concerned about the reproducibility of our builds, and that's why we make use of Docker in order to ensure that our builds are consistent and replicable.
+
+## 1. Environment variables
+
+So as not to store sensitive data such as private keys and login credentials (required for publishing to Maven Central) in our build scripts, we make use of an environment file not checked into the repository. In order to provide the necessary parameters to the Docker container, do the following:
+
+1. Rename the `env.example` file to `.env`.
+2. Fill-in the variables as instructed in the comments.
+
+## 2. Build image and run build
+
+In order to automate even more the automation that the Docker image itself already provides, we make use of Docker Compose. The provided `docker-compose.yml` file will build the image, pick up the environment file and mount a volume that exposes the container's local Maven repository, so that you can test the artifacts before publishing them. All you have to do, is the following:
+
+```bash
+cd docker-android/
+docker-compose up --build
+```
+
+## 3. Test Maven artifact locally
+
+Testing in production is not really a great idea. It is recommended that you first test your artifacts locally, before publishing them to Maven Central. Doing this will require modifying the top-level `build.gradle` of the Android app that uses this artifact:
+
+```groovy
+allprojects {
+    repositories {
+        maven {
+            url '<absolute-path-to-quickjs-tart>/.m2/repository/'
+        }
+        // ...
+    }
+}
+```
+
+Now, add the dependency to the module-level `build.gradle`:
+
+```groovy
+dependencies {
+    // ...
+    implementation "net.taler.qtart:<version>@aar"
+    // ...
+}
+```