Merge pull request #1629 from kiwix/release/3.1.0

Release/3.1.0

Author: macgills

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,14 @@
-Fixes #[Add issue number here. If you do not solve the issue entirely, please change the message e.g. "First steps for issues #IssueNumber]
+<!--
+- Add the issue number here.
 
-Changes: [Add here what changes were made in this issue and if possible provide links.]
+- If you haven't solved the issue completely use "Linked issue #{issue_number}.
+- After solving the issue completely change it to "Fixes #{issue_number}.
+-->
+Fixes #
 
-Screenshots/GIF for the change: [If possible, please add relevant screenshots/GIF]
+<!-- Add here what changes were made in this issue and if possible provide links. -->
+
+
+<!-- If possible, please add relevant screenshots / GIFs -->
+
+**Screenshots** 

.gitignore

@@ -66,3 +66,4 @@ captures/
 !/.idea/encodings.xml
 !/.idea/copyright/
 !/.idea/compiler.xml
+app/jacoco.exec

.idea/codeStyles/Project.xml

@@ -15,19 +15,10 @@ env:
 
 if: type != push OR tag IS present
 
-before_install:
-  - openssl aes-256-cbc -K $encrypted_82adfa9c3806_key -iv $encrypted_82adfa9c3806_iv -in secrets.tar.enc -out secrets.tar -d
-  - tar xvf secrets.tar
-
 install:
   - pip install --user 'requests[security]'
   - wget -r -nH -nd -np -R index.html* robots.txt* http://download.kiwix.org/dev/android/api/licenses/ -e robots=off -P $ANDROID_HOME/licenses || true
 
-addons:
-  apt:
-    packages:
-      - lynx
-
 before_cache:
   - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
   - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
@@ -57,23 +48,18 @@ before_script:
   - adb shell input keyevent 82 &
 
 script:
-  - ./gradlew createKiwixDebugCoverageReport lintKiwixDebug jacocoTestKiwixDebugUnitTestReport assemble
+  - ./gradlew jacocoInstrumentationTestReport ktlintCheck app:lintDebug core:lintDebug custom:lintCustomexampleDebug jacocoTestDebugUnitTestReport jacocoTestCustomExampleDebugUnitTestReport app:assembleDebug
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)
-  - ./gradlew kiwixtestUploadKiwix
-
-after_failure:
-  - export REPORT_DIR=${TRAVIS_HOME}/build/kiwix/kiwix-android/app/build/outputs/reports/
-  - export LOG_DIR=${REPORT_DIR}androidTests/connected/flavors/KIWIX/
-  - lynx -dump ${LOG_DIR}index.html
-  - lynx -dump ${REPORT_DIR}lint-results-kiwixDebug.html
-
+  - openssl aes-256-cbc -K $encrypted_82adfa9c3806_key -iv $encrypted_82adfa9c3806_iv -in secrets.tar.enc -out secrets.tar -d
+  - tar xvf secrets.tar
+  - ./gradlew app:assembleRelease
 
 before_deploy:
   #  - export APP_CHANGELOG=$(cat app/src/kiwix/play/release-notes/en-US/default.txt)
   - export DATE=$(date +%Y-%m-%d)
-  - export OUTPUT_DIR=app/build/outputs/apk/kiwix
+  - export OUTPUT_DIR=app/build/outputs/apk
   - export UNIVERSAL_RELEASE_APK=$OUTPUT_DIR/release/*universal*.apk
   - export UNIVERSAL_DEBUG_APK=$OUTPUT_DIR/debug/*universal*.apk
   - export SSH_KEY=travisci_builder_id_key
@@ -96,7 +82,7 @@ deploy:
   #publish on play store
   - provider: script
     skip_cleanup: true
-    script: ./gradlew publishKiwixRelease
+    script: ./gradlew publishReleaseApk
     on:
       tags: true
 

.idea/copyright/Kiwix_Copyright_Profile.xml

@@ -1,3 +1,10 @@
+3.1.0
+NEW: Revamped Night Mode
+NEW: Books unsupported by file system are greyed out
+NEW: Tags for books
++ Bugfixes & Lots More
+
+
 3.0.5
 BUGFIX: Some zim files could not be downloaded due to missing metadata
 BUGFIX: Some mirrors were not allowed to download via http

.idea/copyright/profiles_settings.xml

@@ -48,51 +48,56 @@ Our branching strategy is based on [this article](https://nvie.com/posts/a-succe
 + **develop**  the actively worked on next release of the app, what we branch off of while working on new features and what we merge into upon feature completion
 + **feature/** or feature/\<username\>/ any branch under this directory is an actively developed feature, feature branches culminate in a PR, are merged and deleted.
  Typically a feature branch is off of develop and into develop but in rare scenarios if there is an issue in production a branch may be made off master to fix this issue, this type of feature branch must be merged to develop and master before being deleted.
-Branch names should be in the format **#\<issue-number\>-kebab-case-title**
+Branch names should be in the format **\<issue-number\>-kebab-case-title**
 
 All branches should have distinct history and should be visually easy to follow, for this reason only perform merge commits when merging code either by PR or when synchronising.
 
 If you wish to rebase you should be following the [Golden Rule](https://www.atlassian.com/git/tutorials/merging-vs-rebasing#the-golden-rule-of-rebasing) and ahere to the advice in the heading [Aside: Rebase as cleanup is awesome in the coding lifecycle](https://www.atlassian.com/git/articles/git-team-workflows-merge-or-rebase).
 
 ### Building
 
-The default build is `debug`, with this variant you can use a debugger while developing. To install the application click the `run` button in Android Studio with the `app` configuration selected while you have a device connected. All other build types but `release` can be ignored, the `release` build is what gets uploaded to the Google Play store and can be built locally with the dummy credentials/keystore provided.
+The Kiwix app is split into 3 modules
+1. `core` - the "core" functionality of the app shared between different clients
+1. `app` - the main app Kiwix, Wikipedia Offline
+1. `custom` - this is for building custom applications that supply only 1 zim file and a custom skin
+
+The default build is `debug`, with this variant you can use a debugger while developing. To install the application click the `run` button in Android Studio with the `app` configuration selected while you have a device connected. The `release` build is what gets uploaded to the Google Play store and can be built locally with the dummy credentials/keystore provided.
 
 By default we fetch kiwix-lib, the key component for interacting with ZIM files from maven, but if you wish to use your own locally compiled version for testing purposes, then you can create the directory `app/libs` and place your .aar file inside it to have it used instead.
 
 ### Testing
 
-Unit tests are located in `app/src/test` and to run them locally you
+Unit tests are located in `[module]/src/test` and to run them locally you
 can use the gradle command:
 
-        $ gradlew testKiwixDebugUnitTest
+        $ gradlew testDebugUnitTest
 
 or the abbreviated:
 
-        $ gradlew tKDUT
+        $ gradlew tDUT
 
-Automated tests that require a connected device (UI related tests) are located in `app/src/androidTest` & `app/src/androidTestKiwix`, to run them locally you can use the gradle command:
+Automated tests that require a connected device (UI related tests) are located in `[module]/src/androidTest` & `app/src/androidTestKiwix`, to run them locally you can use the gradle command:
 
-        $ gradlew connectedKiwixDebugAndroidTest
+        $ gradlew connectedDebugAndroidTest
 
 or the abbreviated:
 
 
-        $ gradlew cKDAT
+        $ gradlew cDAT
 
-All local test results can be seen under `app/build/reports/`
+All local test results can be seen under `[module]/build/reports/`
 
 ### Code coverage
 
 To generate coverage reports for your unit tests run:
 
-        $ gradlew jacocoTestKiwixDebugUnitTest
+        $ gradlew jacocoTestReport
 
 To generate coverage reports for your automated tests run:
 
-        $ gradlew createKiwixDebugCoverageReport
+        $ gradlew jacocoInstrumentationTestReport
 
-Code coverage results can be seen under `app/build/reports/`
+Code coverage results can be seen under `[module]/build/reports/`
 
 ### Continous Integration