diff --git a/docs/CROWDIN/cs/AdvancedOptions/DevBranch.md b/docs/CROWDIN/cs/AdvancedOptions/DevBranch.md index f2e6c9a1d022..b7f85ef9a0e8 100644 --- a/docs/CROWDIN/cs/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/cs/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ Nicméně Dev větev je dobré místo, kde se ukazují testované funkce a můž Pokud najdete chybu nebo si myslíte, že se stalo něco špatného při používání Dev větve, pak se podívejte na záložku [Issues](https://github.com/nightscout/AndroidAPS/issues), abyste prověřili, jestli to už nenahlásil někdo jiný, pokud ne, tak problém rovnou nahlaste. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). O nových funkcích můžete diskutovat také na [Discordu](https://discord.gg/4fQUWHZ4Mw). -Verze pro vývojáře má konečný datum vypršení platnosti. To se zdá nepříjemné při jeho uspokojivém používání, ale má to svůj smysl. Když je rozšířena pouze jedna vývojářská verze, je snažší sledovat nahlášené chyby. Vývojáři nechtějí být v situaci, kdy jsou mezi lidmi 3 různé vývojářské verze, v některých jsou opravené chyby a v jiných nejsou, a lidé stále znovu hlásí již vyřešené chyby. \ No newline at end of file +Verze pro vývojáře má konečný datum vypršení platnosti. To se zdá nepříjemné při jeho uspokojivém používání, ale má to svůj smysl. Když je rozšířena pouze jedna vývojářská verze, je snažší sledovat nahlášené chyby. Vývojáři nechtějí být v situaci, kdy jsou mezi lidmi 3 různé vývojářské verze, v některých jsou opravené chyby a v jiných nejsou, a lidé stále znovu hlásí již vyřešené chyby. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/cs/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/cs/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..c840bbb7bd21 --- /dev/null +++ b/docs/CROWDIN/cs/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Vyrobte si místo stažení + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. Je legální vytvořit aplikaci pro své vlastní použití, ale nesmíte dát kopii ostatním!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md index 282f472e17fc..9eae40b9560f 100644 --- a/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/cs/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/de/AdvancedOptions/DevBranch.md b/docs/CROWDIN/de/AdvancedOptions/DevBranch.md index 655269781c2d..a91c94efa848 100644 --- a/docs/CROWDIN/de/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/de/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ Im Dev branch sieht man, welche Funktionen gerade getestet werden. Damit können Wenn Du einen Fehler gefunden hast oder glaubst, dass etwas falsch berechnet wurde, dann sehe im [issues tab](https://github.com/nightscout/AndroidAPS/issues) nach, um zu sehen, ob schon jemand diesen Fehler bemerkt hat, falls nicht, kannst Du einen neuen Issue öffnen. Je mehr Informationen Du dabei mitlieferst, desto besser/schneller kann der Fehler reproduziert und behoben werden. Vergiss nicht, die [Protokolldateien](../GettingHelp/AccessingLogFiles.md) anzufügen. Die neuen Funktionen können auch auf [discord](https://discord.gg/4fQUWHZ4Mw) diskutiert werden. -Eine Entwickler-Version hat ein Ablaufdatum. Das scheint unpraktisch, wenn es zufriedenstellend genutzt wird, aber es dient einem Zweck. Wenn eine einzelne Dev-Version die Runden macht, ist es einfacher, Fehler zu verfolgen, die Leute melden. Die Entwickler wollen nicht in einer Position sein, in der es drei Versionen von dev im Umlauf sind, in denen Fehler behoben werden müssen und Testuser Fehler, die schon behoben wurden in der aktuellsten Dev-Version, in guter Absicht nochmals melden. \ No newline at end of file +Eine Entwickler-Version hat ein Ablaufdatum. Das scheint unpraktisch, wenn es zufriedenstellend genutzt wird, aber es dient einem Zweck. Wenn eine einzelne Dev-Version die Runden macht, ist es einfacher, Fehler zu verfolgen, die Leute melden. Die Entwickler wollen nicht in einer Position sein, in der es drei Versionen von dev im Umlauf sind, in denen Fehler behoben werden müssen und Testuser Fehler, die schon behoben wurden in der aktuellsten Dev-Version, in guter Absicht nochmals melden. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/de/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/de/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..8caa705b66e2 --- /dev/null +++ b/docs/CROWDIN/de/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Kein Download möglich - APK muss selbst erstellt werden + +**Die AAPS-App (eine apk-Datei) ist aufgrund der Vorschriften rund um medizinische Geräte nicht zum Download verfügbar. Es ist zulässig, die App für den eigenen Gebrauch zu erstellen, aber du darfst keine Kopie an andere weitergeben!** + +Zu den Details schaue bitte auf die [FAQ-Seite](../UsefulLinks/FAQ.md). + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md index 2579761a7809..b8b9ae4d03f0 100644 --- a/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ Die Gradle-Version ist mit dem Quellcode verknüpft. Wenn Du den Quellcode herun

RAM -

8GB oder mehr +

16GB or more

Festplatte diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/de/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/el/AdvancedOptions/DevBranch.md b/docs/CROWDIN/el/AdvancedOptions/DevBranch.md index a8ff20323253..f4e8e8e1aca5 100644 --- a/docs/CROWDIN/el/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/el/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ The dev version of AAPS is only for developers and testers comfortable dealing w If you find a bug or think something wrong has happened when using the Dev branch, then view the [issues tab](https://github.com/nightscout/AndroidAPS/issues) to check whether anyone else has found it, or add it yourself if not. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/el/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/el/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..e4fd559e27c8 --- /dev/null +++ b/docs/CROWDIN/el/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Φτιάξτε το μόνοι σας, αντί να το κατεβάσετε + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md index 40195217b957..3caf1c7ea56c 100644 --- a/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/el/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/es/AdvancedOptions/DevBranch.md b/docs/CROWDIN/es/AdvancedOptions/DevBranch.md index 88be4b7fe386..0e0b2343bbfe 100644 --- a/docs/CROWDIN/es/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/es/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ Sin embargo, la rama de desarrollo es un buen lugar para ver qué característic Si encuentra un error o cree que ha ocurrido algo incorrecto al utilizar la ramificación de desarrollo, visualice la [pestaña de problemas](https://github.com/nightscout/AndroidAPS/issues) para comprobar si alguien más lo ha encontrado o si lo ha añadido si no lo ha hecho. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/es/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/es/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..2055e5edb9d5 --- /dev/null +++ b/docs/CROWDIN/es/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Construyela tú mismo en lugar de descargarla + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md index e446c025ced3..f2824f608a5c 100644 --- a/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/es/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/fr/AdvancedOptions/DevBranch.md b/docs/CROWDIN/fr/AdvancedOptions/DevBranch.md index 1628e23bc162..1cdb17ee15f2 100644 --- a/docs/CROWDIN/fr/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/fr/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ Cependant, la branche Dev est un bon endroit pour voir quelles fonctionnalités Si vous trouvez un bug ou pensez que quelque chose d'anormal s'est produit lors de l'utilisation de la branche Dev, alors consultez l'onglet [problèmes](https://github.com/nightscout/AndroidAPS/issues) pour vérifier si quelqu'un d'autre a reporté le même problème, ou ajoutez-le vous-même si ce n'est pas le cas. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). Les nouvelles fonctionnalités peuvent également être discutées dans [discord](https://discord.gg/4fQUWHZ4Mw). -Une version de dev a une date d'expiration. Cela semble gênant lorsqu'on son utilisation est satisfaisante, mais cela a un but : Lorsqu'une seule version de développement est en cours d'utilisation, il est plus facile de traquer les bugs que les gens signalent. Les développeurs ne veulent pas se retrouver dans une situation où il y a trois versions de dev dans la nature où les bogues sont corrigés dans certaines et pas dans d'autres, et les gens continuent de remonter des problèmes corrigés. \ No newline at end of file +Une version de dev a une date d'expiration. Cela semble gênant lorsqu'on son utilisation est satisfaisante, mais cela a un but : Lorsqu'une seule version de développement est en cours d'utilisation, il est plus facile de traquer les bugs que les gens signalent. Les développeurs ne veulent pas se retrouver dans une situation où il y a trois versions de dev dans la nature où les bogues sont corrigés dans certaines et pas dans d'autres, et les gens continuent de remonter des problèmes corrigés. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/fr/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/fr/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..a020c350b1bb --- /dev/null +++ b/docs/CROWDIN/fr/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Construire vous-même au lieu de télécharger + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. Il est légal de construire l'application pour votre usage personnel, mais vous ne devez en aucun cas donner une copie à d'autres personnes !** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md index 2ea8e7bcbb89..fd86989ad5c1 100644 --- a/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/fr/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/he/AdvancedOptions/DevBranch.md b/docs/CROWDIN/he/AdvancedOptions/DevBranch.md index 54bd73b55794..8d19b85f73c5 100644 --- a/docs/CROWDIN/he/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/he/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ However, the Dev branch is a good place to see what features are being tested an If you find a bug or think something wrong has happened when using the Dev branch, then view the [issues tab](https://github.com/nightscout/AndroidAPS/issues) to check whether anyone else has found it, or add it yourself if not. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/he/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/he/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..b96a8d50ec5c --- /dev/null +++ b/docs/CROWDIN/he/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## בנייה עצמית במקום הורדה + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. בנייה עצמית של היישום לשימוש אישי הינה חוקית אך אסור לתת את היישום לאחרים!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md index 99f2ccbde81d..e88f143f0c5b 100644 --- a/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/he/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/ko/AdvancedOptions/DevBranch.md b/docs/CROWDIN/ko/AdvancedOptions/DevBranch.md index 54bd73b55794..8d19b85f73c5 100644 --- a/docs/CROWDIN/ko/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/ko/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ However, the Dev branch is a good place to see what features are being tested an If you find a bug or think something wrong has happened when using the Dev branch, then view the [issues tab](https://github.com/nightscout/AndroidAPS/issues) to check whether anyone else has found it, or add it yourself if not. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/ko/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/ko/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..c34f5a7fa39f --- /dev/null +++ b/docs/CROWDIN/ko/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## 다운로드 대신에 당신 스스로 빌드하세요 + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md index 630477f2d718..884efef4c1a9 100644 --- a/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/ko/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/lt/AdvancedOptions/DevBranch.md b/docs/CROWDIN/lt/AdvancedOptions/DevBranch.md index 06e2ec69b2d0..9fedac5f49a6 100644 --- a/docs/CROWDIN/lt/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/lt/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ Tačiau kūrėjo versija yra gera vieta pamatyti, kokios funkcijos yra tikrinamo Jei radote klaidą arba manote, kad naudojant kūrėjo versiją nutiko kažkas neprimtino, tada peržiūrėkite skirtuką [problemos](https://github.com/nightscout/AndroidAPS/issues) ir patikrinkite, ar kas nors kitas šią problemą rado, arba pridėkite patys, jei esate pirmasis. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/lt/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/lt/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..31f34374b2ef --- /dev/null +++ b/docs/CROWDIN/lt/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Kurti sau, o ne parsisiųsti + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md index a364ac5d915a..7366a2d975a9 100644 --- a/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/lt/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/nl/AdvancedOptions/DevBranch.md b/docs/CROWDIN/nl/AdvancedOptions/DevBranch.md index abcbdab2564f..8c9bac3dda42 100644 --- a/docs/CROWDIN/nl/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/nl/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ In de Dev branch kun je zien welke functies worden getest, en je kunt er helpen Als je een bug vindt of denkt dat er iets mis is gegaan terwijl je de Dev branch gebruikt, kijk dan op het tabblad [issues](https://github.com/nightscout/AndroidAPS/issues) om te zien of iemand anders al hetzelfde heeft gehad, of voeg het zelf toe als dat niet het geval is. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). Nieuwe functies kun je ook bespreken op [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/nl/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/nl/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..1280fa069524 --- /dev/null +++ b/docs/CROWDIN/nl/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Zelf bouwen, in plaats van downloaden + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md index fb76b66365b9..9b9126102a34 100644 --- a/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/nl/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/pb/AdvancedOptions/DevBranch.md b/docs/CROWDIN/pb/AdvancedOptions/DevBranch.md index 54bd73b55794..8d19b85f73c5 100644 --- a/docs/CROWDIN/pb/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/pb/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ However, the Dev branch is a good place to see what features are being tested an If you find a bug or think something wrong has happened when using the Dev branch, then view the [issues tab](https://github.com/nightscout/AndroidAPS/issues) to check whether anyone else has found it, or add it yourself if not. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/pb/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/pb/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..540eaed303d7 --- /dev/null +++ b/docs/CROWDIN/pb/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Build yourself instead of download + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md index 0d201ffa6c3a..4710b96c04e9 100644 --- a/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/pb/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/pl/AdvancedOptions/DevBranch.md b/docs/CROWDIN/pl/AdvancedOptions/DevBranch.md index 54bd73b55794..8d19b85f73c5 100644 --- a/docs/CROWDIN/pl/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/pl/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ However, the Dev branch is a good place to see what features are being tested an If you find a bug or think something wrong has happened when using the Dev branch, then view the [issues tab](https://github.com/nightscout/AndroidAPS/issues) to check whether anyone else has found it, or add it yourself if not. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/pl/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/pl/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..540eaed303d7 --- /dev/null +++ b/docs/CROWDIN/pl/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Build yourself instead of download + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md index 0d201ffa6c3a..4710b96c04e9 100644 --- a/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/pl/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/pt/AdvancedOptions/DevBranch.md b/docs/CROWDIN/pt/AdvancedOptions/DevBranch.md index 31498a4363f1..b203e708bf4f 100644 --- a/docs/CROWDIN/pt/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/pt/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ No entanto, a branch Dev é um boa para ver que recursos estão sendo testados e Se você encontrar um bug ou achar que algo errado aconteceu ao usar a Dev branch, então visualize o separador[questões](https://github.com/nightscout/AndroidAPS/issues) para verificar se alguém mais o encontrou, ou, caso contrário, adicioná-lo você mesmo. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/pt/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/pt/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..0fa29fc0060f --- /dev/null +++ b/docs/CROWDIN/pt/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Construa você em vez de fazer download + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md index ee1e9e0918ae..0348e953a1b1 100644 --- a/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/pt/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/ro/AdvancedOptions/DevBranch.md b/docs/CROWDIN/ro/AdvancedOptions/DevBranch.md index 54bd73b55794..8d19b85f73c5 100644 --- a/docs/CROWDIN/ro/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/ro/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ However, the Dev branch is a good place to see what features are being tested an If you find a bug or think something wrong has happened when using the Dev branch, then view the [issues tab](https://github.com/nightscout/AndroidAPS/issues) to check whether anyone else has found it, or add it yourself if not. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/ro/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/ro/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..540eaed303d7 --- /dev/null +++ b/docs/CROWDIN/ro/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Build yourself instead of download + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md index 0d201ffa6c3a..4710b96c04e9 100644 --- a/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/ro/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/ru/AdvancedOptions/DevBranch.md b/docs/CROWDIN/ru/AdvancedOptions/DevBranch.md index 2bdc5fe8fc0f..56d2e83b2d14 100644 --- a/docs/CROWDIN/ru/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/ru/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ Если вы нашли ошибку или думаете, что что-то пошло не так в версии dev, просмотрите [вкладку проблемы](https://github.com/nightscout/AndroidAPS/issues) и проверьте, не столкнулся ли с проблемой кто-либо еще, и, если нет, добавьте ее сами. Чем больше информации вы можете здесь разместить, тем лучше (не забывайте, что от вас могут понадобиться [лог-файлы](../GettingHelp/AccessingLogFiles.md). Новые функции можно также обсудить в [ discord ](https://discord.gg/4fQUWHZ4Mw). -Версия Dev имеет дату окончания срока действия. Это кажется неудобным при удовлетворительной работе, но служит определенной цели. Когда в цикле единичная версия dev, легче отслеживать ошибки, о которых сообщают люди. Разработчики не хотят, чтобы существовало три версии dev, где в одной ошибки исправлены, а в другой нет. и люди продолжают сообщать об уже исправленных. \ No newline at end of file +Версия Dev имеет дату окончания срока действия. Это кажется неудобным при удовлетворительной работе, но служит определенной цели. Когда в цикле единичная версия dev, легче отслеживать ошибки, о которых сообщают люди. Разработчики не хотят, чтобы существовало три версии dev, где в одной ошибки исправлены, а в другой нет. и люди продолжают сообщать об уже исправленных. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/ru/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/ru/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..9dbc6ed930b3 --- /dev/null +++ b/docs/CROWDIN/ru/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Постройте сами вместо скачивания + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. Построить приложение для собственного использования вполне законно, но передавать копию другим не разрешается!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md index a0b15a520c1e..66ef929d6ed8 100644 --- a/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/ru/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/sk/AdvancedOptions/DevBranch.md b/docs/CROWDIN/sk/AdvancedOptions/DevBranch.md index 54bd73b55794..8d19b85f73c5 100644 --- a/docs/CROWDIN/sk/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/sk/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ However, the Dev branch is a good place to see what features are being tested an If you find a bug or think something wrong has happened when using the Dev branch, then view the [issues tab](https://github.com/nightscout/AndroidAPS/issues) to check whether anyone else has found it, or add it yourself if not. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). The new features can also be discussed on [discord](https://discord.gg/4fQUWHZ4Mw). -A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. \ No newline at end of file +A dev version has an expiration date. This seems inconvenient when using it satisfactorily, but serves a purpose. When a single dev version doing the rounds, it is easier to keep track of bugs that people are reporting. The developers do not want to be in a position where there are three versions of dev in the wild where bugs are fixed in some and not others, and people continue to report the fixed ones. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/sk/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/sk/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..540eaed303d7 --- /dev/null +++ b/docs/CROWDIN/sk/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Build yourself instead of download + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md index 0d201ffa6c3a..4710b96c04e9 100644 --- a/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/sk/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/tr/AdvancedOptions/DevBranch.md b/docs/CROWDIN/tr/AdvancedOptions/DevBranch.md index fa2e830a4109..d96d5c9d3445 100644 --- a/docs/CROWDIN/tr/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/tr/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ Bununla birlikte, Dev branch, hangi özelliklerin test edildiğini görmek ve ha Dev branch kullanırken bir hata bulursanız veya yanlış bir şey olduğunu düşünüyorsanız, aynı sorunla karşılaşan herhangi birinin olup olmadığını kontrol etmek için [sorunlar sekmesini](https://github.com/nightscout/AndroidAPS/issues) görüntüleyin. Eğer yoksa kendiniz ekleyebilirsiniz. The more information you can share here the better (don't forget you may need to share your [log files](../GettingHelp/AccessingLogFiles.md). Yeni özellikler ayrıca [discord](https://discord.gg/4fQUWHZ4Mw)'da tartışılabilir. -Bir geliştirme sürümünün bir son kullanma tarihi vardır. Bu, versiyonun tatmin eden bir kullanımı olduğunda rahatsız edici görünüyor, ancak bir amaca hizmet ediyor. Tek bir geliştirici sürümü kullanılırken, insanların bildirdiği hataları takip etmek daha kolaydır. Geliştiriciler, bazılarında hataların giderildiği, diğerlerinin giderilmediği aynı zamanda insanların hata raporlarını bildirmeye devam ettikleri üç sürümünün olduğu karmaşık bir konumda olmak istemiyorlar. \ No newline at end of file +Bir geliştirme sürümünün bir son kullanma tarihi vardır. Bu, versiyonun tatmin eden bir kullanımı olduğunda rahatsız edici görünüyor, ancak bir amaca hizmet ediyor. Tek bir geliştirici sürümü kullanılırken, insanların bildirdiği hataları takip etmek daha kolaydır. Geliştiriciler, bazılarında hataların giderildiği, diğerlerinin giderilmediği aynı zamanda insanların hata raporlarını bildirmeye devam ettikleri üç sürümünün olduğu karmaşık bir konumda olmak istemiyorlar. + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/tr/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/tr/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..620254460a38 --- /dev/null +++ b/docs/CROWDIN/tr/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## Programı İndirmek yerine kendiniz oluşturun... + +**The AAPS app (an apk file) is not available for download, due to regulations around medical devices. Uygulamayı kendi kullanımınız için oluşturmak yasaldır, ancak bir kopyasını başkasına vermemelisiniz!** + +See [FAQ page](../UsefulLinks/FAQ.md) for details. + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md index ee44045fb007..5a4823299dae 100644 --- a/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ The Gradle version is linked to the source code, you will always get the correct

RAM -

8GB or more +

16GB or more

Disk diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/tr/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/zh_CN/AdvancedOptions/DevBranch.md b/docs/CROWDIN/zh_CN/AdvancedOptions/DevBranch.md index 6438288f8848..16459866a6b4 100644 --- a/docs/CROWDIN/zh_CN/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/zh_CN/AdvancedOptions/DevBranch.md @@ -10,4 +10,58 @@ AAPS开发版（dev version）仅适用于能够熟练处理堆栈跟踪（stack 若在使用开发分支（Dev branch）时发现程序漏洞或异常情况，请查看[问题标签页（issues tab）](https://github.com/nightscout/AndroidAPS/issues)确认是否已有其他用户提交相同问题；若无相关记录，请自行提交问题报告。 请尽可能详细地在此提供信息（切记可能需要分享您的[日志文件（log files）](../GettingHelp/AccessingLogFiles.md)），信息越详尽越好。 新功能的相关讨论也可在[Discord平台](https://discord.gg/4fQUWHZ4Mw)进行。 -开发版（dev version）设有有效期限制。 这在使用满意时看似不便，但实为有特定设计目的。 如果只有一个开发版本，就更容易跟踪人们报告的错误。 开发者不希望出现三种不同版本的开发模式同时存在的情况，其中某些版本修复了漏洞，而其他版本没有修复，导致人们仍然报告已经修复的问题。 \ No newline at end of file +开发版（dev version）设有有效期限制。 这在使用满意时看似不便，但实为有特定设计目的。 如果只有一个开发版本，就更容易跟踪人们报告的错误。 开发者不希望出现三种不同版本的开发模式同时存在的情况，其中某些版本修复了漏洞，而其他版本没有修复，导致人们仍然报告已经修复的问题。 + +(github-pr-test)= + +## Test items in a pull request (GitHub CI actions deploy) + +Available from 3.3.2.1.dev + +- Suitable for testers or those helping with testing. + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR number: Please enter the PR number that you want to test. + +- PR reference types: PR reference types include two options: + + - head: + - Fetches the actual content from the PR author’s branch (i.e., the original commit history without any merge operations). + - This is equivalent to the original state of the PR branch, as if it were fetched directly from a fork or feature branch. + + - merge: + + - Fetches the result of GitHub’s pre-simulated merge of the PR into the target branch (e.g., dev). + - This is a virtual merge commit automatically created by GitHub. + - This commit only exists when the PR has no conflicts and is mergeable. + + - variant: + + - Please refer to + + (variant)= + + ### variant + + - Select the variant you need: + - fullRelease: For regular pump usage with full functionality. + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) For caregivers (requires [Nightscout](../SettingUpAaps/Nightscout.md))。 + - pumpcontrol + - Text ending with “Debug” indicates that the APK will be built in debug mode, which is useful for troubleshooting. \ No newline at end of file diff --git a/docs/CROWDIN/zh_CN/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/zh_CN/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..0f1ea74b0862 --- /dev/null +++ b/docs/CROWDIN/zh_CN/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# Browser build + +Building AAPS with GitHub Actions. + +**Minimum AAPS version supported is 3.3.2.1.** + +## 自行构建而非下载 + +**由于医疗器械相关法规的限制，AAPS应用（一个apk文件）无法提供下载。 构建该应用供自己使用是合法的，但不得将副本提供给他人** + +详情请参阅[常见问题页面](../UsefulLinks/FAQ.md)。 + +(Building-APK-without-a-computer)= + +## Device and software specifications for building AAPS + +You need an Android device with Android version > ? + +iOS? + +You also need a Google account so that the app can be saved in your Google Drive. + +```{note} +This wiki assumes you're performing all operations with your Android cellular phone and the Chrome web browser. +You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another. +``` + +(github-fork)= + +## 1. AAPS personal fork + +You will need to secretly store your personal Android Java Key and Google Drive information in GitHub (later in the process, we will explain how). + +Since this cannot be done inside the public repository of AndroidAPS, you need to make your personal copy of the source code (called a fork). + +### GitHub account + +You need to [create a GitHub account](https://github.com/signup) if you don't have one yet. +You can sign up with your email, or you can sign up with Google. Follow the registration and verification process. + +When you have an account, [sign in to GitHub](https://github.com/login). + +### Fork AndroidAPS + +Open the official AndroidAPS repository following [this link](https://github.com/nightscout/AndroidAPS). + +Tap on the fork icon. This will create a copy inside your own account. + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +Scroll down the next screen and tap **Create Fork**. + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*Note: you can **unselect** "Copy the main branch only" if you will want to build developers versions or customizations.* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub now displays your personal copy of AndroidAPS. Leave this web browser tab open. + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. Preparation Steps + +- If you are building from an Android device, install [File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager) from the Google Play store. +- Download the preparation file from [here](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html). + +AndroidAPS build requires private keys, that are stored in a Java KeyStore (JKS): + +- If this is your first time building AAPS (or you don't have a an Android Studio JKS), follow [AAPS-CI Option 1 – Generate JKS](aaps-ci-option1) to complete the setup. +- If you want to use your own JKS (the one you used on a previous build of AAPS from a computer in Android Studio), you know its password and alias (key0), please choose [AAPS-CI Option 2 – Upload Existing JKS](aaps-ci-option2). + +```{warning} +Building AAPS with **Option 1** will not allow you to upgrade your existing AAPS: you will need to uninstall it, restore the settings from your phone and data from Nightscout. +``` + +The AAPS app will be saved in your Google Cloud drive once built: + +- Also perform the Google Drive [Auth](aaps-ci-google-drive-auth) to allow the build to be saved there. + +(aaps-ci-option1)= +### AAPS-CI Option 1 – Generate JKS + - Suitable for first-time users, or those without a JKS, or who have forgotten the password or alias. + + Compatible with Android +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI Option 2 – Upload Existing JKS + - Suitable for users who already have a JKS and know the JKS password and alias. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- As described in the video, please copy it to the corresponding field. + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- For KEYSTORE_PASSWORD, KEY_ALIAS, and KEY_PASSWORD, please enter your actual password and alias in GitHub. + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google Drive Auth +- Click Start Auth to begin the authorization process, and set the obtained token in GitHub after authorization. + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions to Build the AAPS APK + - Suitable for general users. +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - In GitHub, go to Actions, select AAPS-CI, and click Run workflow to start building the APK. + +*Note: both Android and Android Wear apps will be built automatically.* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - variant: + - Please refer to [variant](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI Troubleshooting + + (aaps-ci-preparation)= ### aaps-ci-preparation web page + - When you open aaps-ci-preparation.html using a file manager, it will start a temporary local server on your phone to display the webpage and receive the Google refresh token. + - If you see the screen below, it means you have been inactive for a while, and the file manager has already shut down the local server. + - Please reopen aaps-ci-preparation.html using the file manager app and complete the remaining steps. + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +Customizations are usually not necessary. This is for your information ony. +``` + +(github-cherry-pick)= + +## If you want to add a specific commit to your branch, please use cherry-pick. + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - Use workflow from Branch: Please enter the branch name you want to cherry-pick to. + - Upstream Repository: Please enter the repository name you want to cherry-pick from. + - Commit SHA: Please enter the commit SHA you want to cherry-pick.(like git commit hash) + - Select Build Variant: [variant](variant) \ No newline at end of file diff --git a/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md index 31d100c7e46a..1b3deb6ed68a 100644 --- a/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ Gradle版本由源代码仓库锁定，在拉取/更新代码时将自动获取

内存（RAM） -

8GB 或更多 +

16GB or more

硬盘 diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/zh_CN/images/Building-the-App/CI/aaps_ci_pr_ci.png differ diff --git a/docs/CROWDIN/zh_TW/AdvancedOptions/DevBranch.md b/docs/CROWDIN/zh_TW/AdvancedOptions/DevBranch.md index 58d09a2c65a5..de0bb0e01ca2 100644 --- a/docs/CROWDIN/zh_TW/AdvancedOptions/DevBranch.md +++ b/docs/CROWDIN/zh_TW/AdvancedOptions/DevBranch.md @@ -11,4 +11,58 @@ AAPS 的開發版本僅適用於能處理堆棧追蹤、查找日誌文件，甚 如果你發現錯誤或認為使用 dev 分支時發生了問題，請查看[問題標籤](https://github.com/nightscout/AndroidAPS/issues)，看看是否有其他人發現，或者如果沒有，請自己添加。 你在這裡分享的資訊越多越好（不要忘記你可能需要分享你的[日誌檔案](../GettingHelp/AccessingLogFiles.md)）。 新功能也可以在[Discord](https://discord.gg/4fQUWHZ4Mw)上討論。 -開發版本有一個過期日期。 當使用他滿意時，這似乎不便，但他有其作用。 當單一開發版本流傳時，更容易跟踪人們報告的錯誤。 開發人員不希望出現三個開發版本在外流傳，其中一些錯誤在某些版本中已經修復，而其他版本則未修復，而人們仍然繼續報告已經解決的錯誤。 \ No newline at end of file +開發版本有一個過期日期。 當使用他滿意時，這似乎不便，但他有其作用。 當單一開發版本流傳時，更容易跟踪人們報告的錯誤。 開發人員不希望出現三個開發版本在外流傳，其中一些錯誤在某些版本中已經修復，而其他版本則未修復，而人們仍然繼續報告已經解決的錯誤。 + +(github-pr-test)= + +## 拉取請求中的測試項目（GitHub CI 動作部署） + +可從 3.3.2.1.dev 版本開始使用 + +- 適合測試人員或想要測試的人使用。 + +```{eval-rst} +.. raw:: html + + +

+
+ +
+
+``` + +![aaps_ci_pr_ci](C:\Data\50 - My Projects\AAPS\OpenAPS\AndroidAPSdocs\docs\EN\images\Building-the-App\CI\aaps_ci_pr_ci.png) + +- PR 編號：請輸入您想測試的 PR 編號。 + +- PR 參考類型：PR 參考類型包括兩個選項： + + - head: + - 從 PR 作者的分支獲取實際內容（即，原始提交歷史紀錄而不包含任何合併操作）。 + - 這與 PR 分支的原始狀態相同，就像是直接從一個分支或功能分支獲取的資料。 + + - merge: + + - 獲取 GitHub 預先模擬合併 PR 到目標分支（例如，dev）的結果。 + - 這是一個由 GitHub 自動創建的虛擬合併提交。 + - 當 PR 沒有衝突且可合併時，這個提交才會存在。 + + - 變體： + + - 請參考 [變體](variant) + + (variant)= + + ### variant + + - 選擇您需要的變種： + - fullRelease: 用於正常的幫浦使用，具有完整功能。 + - [aapsclient、aapsclient2](../RemoteFeatures/RemoteControl.md#aapsclient) 針對照護者使用（需 [Nightscout](../SettingUpAaps/Nightscout.md)）。 + - pumpcontrol + - 以“Debug”結尾的文字表示 APK 將在除錯模式下建置，這對於除錯很有幫助。 \ No newline at end of file diff --git a/docs/CROWDIN/zh_TW/SettingUpAaps/BrowserBuild.md b/docs/CROWDIN/zh_TW/SettingUpAaps/BrowserBuild.md new file mode 100644 index 000000000000..032ffa87ab96 --- /dev/null +++ b/docs/CROWDIN/zh_TW/SettingUpAaps/BrowserBuild.md @@ -0,0 +1,201 @@ +# 瀏覽器建置 + +使用 GitHub Actions 建置 AAPS。 + +**最低支援 AAPS 版本為 3.3.2.1。** + +## 自行建置，而不是下載 + +**AAPS 應用程式（apk檔案）因醫療設備相關法規而無法下載。 自行建置應用程式以供個人使用是合法的，但你不得將副本提供給他人！** + +詳細資訊請參閱 [FAQ 頁面](../UsefulLinks/FAQ.md)。 + +(Building-APK-without-a-computer)= + +## 建置 AAPS 的裝置和軟體規格 + +您需要一個 Android 裝置，Android 版本 > ? + +iOS? + +您還需要一個 Google 帳號，以便將應用程式保存在您的 Google 雲端硬碟中。 + +```{note} +本維基假設您使用 Android 手機和 Chrome 瀏覽器進行所有操作。 +您將需要在不同的標籤之間切換：從所有標籤關閉開始，以避免在切換時迷失。 +``` + +(github-fork)= + +## 1. AAPS 個人分支 + +您需要秘密儲存您的個人 Android Java 金鑰和 Google 雲端硬碟資訊於 GitHub（稍後我們將會說明如何操作）。 + +由於這無法在 AndroidAPS 的公開庫中完成，您需要製作自己的源代碼副本（稱為分支）。 + +### GitHub 帳號 + +如果您尚未擁有帳號，您需要[創建一個 GitHub 帳號](https://github.com/signup)。 +您可以使用電子郵件註冊，也可以透過 Google 註冊。 遵循註冊和驗證過程。 + +當您擁有帳號後，[登入 GitHub](https://github.com/login)。 + +### 分支 AndroidAPS + +按照[這個連結](https://github.com/nightscout/AndroidAPS)打開官方 AndroidAPS 倉庫。 + +輕觸分支圖示。 這將在您的帳號內創建一個副本。 + +![fork_aaps](../images/Building-the-App/CI/ForkAAPS.png) + +向下滾動至下一個螢幕並輕觸**建立分支**。 + +![fork_aaps_confirm](../images/Building-the-App/CI/ForkAAPS2.png) + +*注意：如果您想要建置開發版本或自訂版本，您可以**取消選擇**「僅複製主分支」。* + +![fork_aaps_main](../images/Building-the-App/CI/ForkAAPS3.png) + +GitHub 現在顯示您個人的 AndroidAPS 副本。 請保持這個瀏覽器標籤開啟。 + +![forked_aaps](../images/Building-the-App/CI/ForkAAPS4.png) + +(aaps-ci-preparation)= + +## 2. 準備步驟 + +- 如果您是從 Android 裝置建置，請從 Google Play 商店安裝[File Manager Plus](https://play.google.com/store/apps/details?id=com.alphainventor.filemanager)。 +- 從[這裡](https://github.com/openaps/AndroidAPSdocs/raw/refs/heads/master/docs/_static/CI/aaps-ci-preparation.html)下載準備檔案。 + +AndroidAPS 建置需要私有金鑰，這些金鑰儲存於 Java 金鑰庫（JKS）： + +- 如果這是您第一次建立 AAPS（或您沒有 Android Studio 的 JKS），請參考 [AAPS-CI 選項 1 – 產生 JKS](aaps-ci-option1) 來完成設定。 +- 如果您想使用自己的 JKS（您在先前的 AAPS 建置中使用的那個 JKS），並且你知道它的密碼和別名（key0），請選擇 [AAPS-CI 選項 2 – 上傳現有的 JKS](aaps-ci-option2)。 + +```{warning} +使用 **選項 1** 建立 AAPS 將不允許您升級現有的 AAPS：您需要卸載它，從您的手機恢復設定，並從 Nightscout 讀取資料。 +``` + +AAPS 應用程式在建立後會保存在您的 Google 雲端硬碟中： + +- 同時執行 Google 雲端硬碟 [授權](aaps-ci-google-drive-auth) 以允許將建置保存到那裡。 + +(aaps-ci-option1)= +### AAPS-CI 選項 1 – 生成 JKS + - 適合首次使用者、沒有 JKS 的使用者或忘記密碼或別名的使用者。 + + 與 Android 相容 +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- 如影片所示，請將其複製到相應的欄位中。 + +![aaps_ci_pr_ci](../images/Building-the-App/CI/aaps_ci_option1.png) + +(aaps-ci-option2)= +### AAPS-CI 選項 2 – 上傳現有 JKS + - 適合已經擁有 JKS 並且知道 JKS 密碼和別名的用戶。 +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + +- 如影片所示，請將其複製到相應的欄位中。 + +![aaps_ci_option2](../images/Building-the-App/CI/aaps_ci_option2.png) + +- 對於 KEYSTORE_PASSWORD、KEY_ALIAS 和 KEY_PASSWORD，請在 GitHub 中輸入您的實際密碼和別名。 + +![aaps_ci_option2_2](../images/Building-the-App/CI/aaps_ci_option2_2.png) + +![aaps_ci_option2_3](../images/Building-the-App/CI/aaps_ci_option2_3.png) + +![aaps_ci_option2_4](../images/Building-the-App/CI/aaps_ci_option2_4.png) + +(aaps-ci-google-drive-auth)= +### AAPS-CI Google 雲端硬碟授權 +- 點擊開始授權以開始授權過程，並在授權後將獲得的令牌設定在 GitHub 中。 + +![aaps_ci_gdrive_auth](../images/Building-the-App/CI/aaps_ci_gdrive_auth.png) + +(github-build-apk)= +## AAPS-CI GitHub Actions 以建置 AAPS APK + - 適合一般使用者。 +```{eval-rst} +.. raw:: html + + +
+
+ +
+
+``` + - 在 GitHub 中，前往 Actions，選擇 AAPS-CI，然後點擊運行工作流以開始建置 APK。 + +*注意： Android 和 Android Wear 應用程式將自動建置。* + + ![aaps_ci_github_build_apk](../images/Building-the-App/CI/aaps_ci_github_build_apk.png) + + - 變體： + - 請參考 [變體](variant) + + + +(aaps-ci-troubleshooting)= +## AAPS-CI 問題排除 + + (aaps-ci-preparation)= ### aaps-ci-preparation 網頁 + - 當您使用「檔案管理器」打開 aaps-ci-preparation.html 時，它會在您的手機上啟動一個臨時本地伺服器來顯示網頁並接收 Google Refresh token。 + - 如果您看到以下螢幕，這表示您已經一段時間未進行操作，檔案管理器已經關閉本地伺服器。 + - 請使用檔案管理器應用程式重新打開 aaps-ci-preparation.html，並完成剩餘步驟。 + + ![aaps_ci_html_not_found](../images/Building-the-App/CI/aaps_ci_html_not_found.png) + + + +-------- + +```{warning} +「自訂」欄位適合熟悉Google Oauth2的人想要使用自已的ClientID時使用。 僅供您參考。 +``` + +(github-cherry-pick)= + +## 如果您想將特定的提交添加到您的分支，請使用 cherry-pick。 + + ![aaps_cherry-pick_ci](../images/Building-the-App/CI/aaps_cherry_pick_ci.png) + + - 使用來自分支的工作流：請輸入您想要 cherry-pick 到的分支名稱。 + - 上游庫：請輸入您想要 cherry-pick 的庫名稱。 + - 提交 SHA：請輸入您想要 cherry-pick 的提交 SHA（類似於 git 提交哈希）。 + - 選擇建構變體： [變體](variant) \ No newline at end of file diff --git a/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md index 034e588dafee..e7fd7ea004c4 100644 --- a/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md @@ -44,7 +44,7 @@ Gradle版本與源代碼相連結，下載/更新源代碼時，你將始終獲

記憶體 -

8GB或更多 +

16GB 或更多

硬碟 diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS.png new file mode 100644 index 000000000000..742b2257a156 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS2.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS2.png new file mode 100644 index 000000000000..69e5fb69a029 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS2.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS3.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS3.png new file mode 100644 index 000000000000..573b59e54b42 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS3.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS4.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS4.png new file mode 100644 index 000000000000..ebaeb615002b Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/ForkAAPS4.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_cherry_pick_ci.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_cherry_pick_ci.png new file mode 100644 index 000000000000..d69f2774b1fd Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_cherry_pick_ci.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_gdrive_auth.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_gdrive_auth.png new file mode 100644 index 000000000000..f03aa55193d0 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_gdrive_auth.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_github_build_apk.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_github_build_apk.png new file mode 100644 index 000000000000..087e6482ed1b Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_github_build_apk.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_html_not_found.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_html_not_found.png new file mode 100644 index 000000000000..1d776df1240c Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_html_not_found.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option1.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option1.png new file mode 100644 index 000000000000..82b89493f729 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option1.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2.png new file mode 100644 index 000000000000..82f2d2eb19f4 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_2.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_2.png new file mode 100644 index 000000000000..4f30837d3fab Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_2.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_3.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_3.png new file mode 100644 index 000000000000..cea0e7679cd5 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_3.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_4.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_4.png new file mode 100644 index 000000000000..08358f5b43e0 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_option2_4.png differ diff --git a/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_pr_ci.png b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_pr_ci.png new file mode 100644 index 000000000000..0cdba426c669 Binary files /dev/null and b/docs/CROWDIN/zh_TW/images/Building-the-App/CI/aaps_ci_pr_ci.png differ