Merge branch 'develop'

.github/workflows/codeql-analysis.yml

@@ -31,14 +31,12 @@ jobs:
           # a pull request then we can checkout the head.
           fetch-depth: 2
 
-      # If this run was triggered by a pull request event, then checkout
-      # the head of the pull request instead of the merge commit.
-      - run: git checkout HEAD^2
-        if: ${{ github.event_name == 'pull_request' }}
+      - name: Delombok
+        uses: advanced-security/delombok@main
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         with:
           languages: ${{ matrix.language }}
 
@@ -54,8 +52,8 @@ jobs:
         #    and modify them (or add more) to build your code if your project
         #    uses a compiled language
 
-        run: ./gradlew build
+        run: ./gradlew assembleDebug
 
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2

.github/workflows/main.yml

@@ -4,23 +4,30 @@ jobs:
   build-and-test:
     name: Build and run tests
     runs-on: macos-latest
+    env:
+      GRADLE_OPTS: -Dorg.gradle.jvmargs="-XX:MaxMetaspaceSize=1g"
     steps:
       - name: Checkout current develop branch
-        uses: actions/checkout@v1
-      - name: Setup JDK 11
-        uses: actions/setup-java@v1
+        uses: actions/checkout@v3
+
+      - name: Setup JDK
+        uses: actions/setup-java@v3
         with:
+          distribution: 'temurin'
           java-version: 11
+          cache: 'gradle'
+
       - name: Run unit/instrumentation tests and coverage generation
         uses: reactivecircus/android-emulator-runner@v2
         with:
-          api-level: 29
-          arch: x86
-          profile: Nexus 6
-          avd-name: test
+          api-level: 30
+          target: google_apis
+          arch: x86_64
+          force-avd-creation: false
           emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim
           disable-animations: true
           script: ./gradlew -Pandroid.testInstrumentationRunnerArguments.notAnnotation=androidx.test.filters.FlakyTest,androidx.test.filters.LargeTest jacocoTestReport --stacktrace
+
       - name: SonarCloud static code and coverage analysis
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.sauce/config.yml

@@ -0,0 +1,45 @@
+apiVersion: v1alpha
+kind: espresso
+sauce:
+  region: eu-central-1
+  retries: 2
+espresso:
+  app: ./omniNotes/build/intermediates/apk/play/debug/OmniNotes-playDebug-6.2.1.apk
+  testApp: ./omniNotes/build/intermediates/apk/androidTest/play/debug/omniNotes-play-debug-androidTest.apk
+suites:
+  - name: "All tests (no flaky, real device only) on Android 13"
+    testOptions:
+      size: large
+      clearPackageData: true
+      useTestOrchestrator: true
+      notAnnotation: it.feio.android.omninotes.testutils.NoRealDeviceTest
+    devices:
+      - name: ".*"
+        platformVersion: "13"
+  - name: "All tests (no flaky, real device only) on Android 12"
+    testOptions:
+      size: large
+      clearPackageData: true
+      useTestOrchestrator: true
+      notAnnotation: it.feio.android.omninotes.testutils.NoRealDeviceTest
+    devices:
+      - name: ".*"
+        platformVersion: "12"
+  - name: "All tests (no flaky, real device only) on Android 10"
+    testOptions:
+      size: large
+      clearPackageData: true
+      useTestOrchestrator: true
+      notAnnotation: it.feio.android.omninotes.testutils.NoRealDeviceTest
+    devices:
+      - name: ".*"
+        platformVersion: "10"
+  - name: "All tests (no flaky, real device only) on Android 9"
+    testOptions:
+      size: large
+      clearPackageData: true
+      useTestOrchestrator: true
+      notAnnotation: it.feio.android.omninotes.testutils.NoRealDeviceTest
+    devices:
+      - name: ".*"
+        platformVersion: "9"

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+## Contributing
+
+Due to the fact that I'm using [gitflow](https://github.com/nvie/gitflow) as code versioning methodology, you as developer should **always** start working on [develop branch](https://github.com/federicoiosue/Omni-Notes/tree/develop) that contains the most recent changes.
+
+There are many features/improvements that are not on **my** roadmap but someone else could decide to work on them anyway: hunt for issues tagged as [Help Wanted](https://github.com/federicoiosue/Omni-Notes/issues?utf8=✓&q=label%3A"Help+wanted") to find them!
+
+Feel free to add yourself to [contributors.md](https://github.com/federicoiosue/Omni-Notes/blob/develop/CONTRIBUTORS.md) file.
+
+### New feature or improvements contributions
+
+This kind of contributions **must** have screenshots or screencast as demonstration of the new additions.
+
+### Code style
+
+If you plan to manipulate the code then you'll have to do it by following a [specific code style](https://gist.github.com/federicoiosue/dee53e882b3c70d544f8608769eb02fc).
+Also pay attention if you're using any plugin that automatically formats/cleans/rearrange your code and set it to only change that code that you touched and not the whole files.
+
+### Test your code contributions!
+
+All code changes and additions **must** be tested.
+See the [related section](#test) for more informations or this two pull requests comments: [one](https://github.com/federicoiosue/Omni-Notes/pull/646#pullrequestreview-187973443) and [two](https://github.com/federicoiosue/Omni-Notes/pull/683#issuecomment-506206689)
+
+### Forking project
+
+When forking the project you'll have to modify some files that are strictly dependent from my own development / build / third-party-services environment. Files that need some attention are the following:
+
+  - *gradle.properties*: this is overridden by another file with the same name inside the *omniNotes* module. You can do the same or leave as it is, any missing property will let the app gracefully fallback on a default behavior.
+
+## Code quality
+
+A public instance of SonarQube is available both to encourage other developers to improve their code contributions (and existing code obviously) and to move the project even further into transparency and openness.
+
+Checkout for it [here](https://sonarcloud.io/dashboard?id=omni-notes)
+
+Pull requests will be automatically analyzed and rejected if they'll rise the code technical debt.

README.md

@@ -3,17 +3,17 @@
 Omni-Notes
 ==========
 
-![License](https://img.shields.io/badge/License-GPLv3-red.svg)
+[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![CI workflow](https://github.com/federicoiosue/Omni-Notes/workflows/CI/badge.svg)](https://github.com/federicoiosue/Omni-Notes/actions?query=workflow%3ACI)
 [![CodeQL Workflow](https://github.com/federicoiosue/Omni-Notes/workflows/CodeQL/badge.svg)](https://github.com/federicoiosue/Omni-Notes/actions?query=workflow%3ACodeQL)
 [![Sonarcloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=omni-notes&metric=coverage)](https://sonarcloud.io/dashboard?id=omni-notes)
 [![Sonarcloud Maintainability](https://sonarcloud.io/api/project_badges/measure?project=omni-notes&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=omni-notes)
 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/omni-notes/localized.png)](https://crowdin.com/project/omni-notes)
-[![GitHub release](https://img.shields.io/github/release/federicoiosue/omni-notes.svg)](https://github.com/federicoiosue/Omni-Notes/releases/latest)
+[![GitHub release](https://badgen.net/github/release/federicoiosue/Omni-Notes)](https://github.com/federicoiosue/Omni-Notes/releases/latest)
 
-Note taking <b>open-source</b> application aimed to have both a <b>simple interface</b> but keeping <b>smart</b> behavior.
+Omni-Notes is a note taking <b>open-source</b> application aimed to have both a <b>simple interface</b> while keeping <b>smart</b> behavior. This application expands on the generic note taking features of other basic applications and allows for users to attach image and video files, use a variety of widgets, tag and organize notes, search through notes, and customize the applications UI.
 
-The project was inspired by the absence of such applications compatible with old phones and old versions of Android. It aims to provide an attractive look and follow the most recent design guidelines of the Google operating system.
+The project was inspired by the absence of such applications compatible with old phones and old versions of Android. It aims to provide an attractive look and follow the most recent design guidelines of the Google operating system that is not currently avaialbe for older devices.
 
 **Follow the developments and post your comments and advice on Facebook Community at https://www.facebook.com/OmniNotes**
 
@@ -33,21 +33,16 @@ If you're willing to help speeding up developments please also opt-in for the Al
 
 Currently the following functions are implemented:
 
-* Material Design interface
-  *Basic add, modify, archive, trash and delete notes actions
-* Share, merge and search notes
-* Image, audio and generic file attachments
-* Manage your notes using tags and categories
-* To-do list
-* Sketch-note mode
-* Notes shortcut on home screen
-* Export/import notes to backup
-* Google Now integration: just tell "write a note" followed by the content
-* Multiple widgets, DashClock extension, Android 4.2 lockscreen compatibility
-* Multilanguage: 30+ languages supported: https://crowdin.com/project/omni-notes
+* <b>Material Design interface:</b> Basic add, modify, archive, trash and delete notes actions
+* <b> Advanced Navigation and Sharing: </b>Share, merge and search notes, Export/import notes to backup
+* <b> Media Attachments: </b> Image, audio and generic file attachments
+* <b>Organization: </b>Manage your notes using tags and categories
+* <b>Specialty Features:</b>To-do list, Sketch-note mode, Google Now integration: just tell "write a note" followed by the content
+* <b> Widget Capabilities: </b>Multiple widgets, DashClock extension, Android 4.2 lockscreen compatibility, Notes shortcut on home screen
+* <b> Internationalization: </b>Multilanguage: 30+ languages supported: https://crowdin.com/project/omni-notes
 
 
-Further developments will include:
+Future Developments:
 
 * Notes sychronization
 * Web interface to manage notes ([stub project](https://github.com/federicoiosue/omni-notes-desktop))
@@ -56,6 +51,7 @@ You can find a complete changelog inside the application settings menu!
 
 If you need some help on how to use the application you'll find everything you need in the [Help Online](assets/help/help.md) section.
 
+[![Promo video](https://raw.githubusercontent.com/federicoiosue/Omni-Notes/develop/assets/promo_video_thumb.png)](https://youtu.be/0Z_-SgT3qYs "Promo video")
 ![](https://raw.githubusercontent.com/federicoiosue/Omni-Notes/develop/assets/play_store_pics/02.png)
 ![](https://raw.githubusercontent.com/federicoiosue/Omni-Notes/develop/assets/play_store_pics/03.png)
 ![](https://raw.githubusercontent.com/federicoiosue/Omni-Notes/develop/assets/play_store_pics/04.png)
@@ -74,9 +70,20 @@ Look into the wiki for GIFs-based tutorials: [LINK](https://github.com/federicoi
 
 ## Build
 
-Watch the following terminal session recording on how to compile distributable files
+Watch the following terminal session recording on how to compile distributable files or follow the instructions below
 [![asciicast](https://asciinema.org/a/102898.png)](https://asciinema.org/a/102898)
 
+Build instructions:
+* Enter your computer's terminal
+* Clone the application by using the link to the repository (https://github.com/federicoiosue/Omni-Notes), this will take a couple minutes
+* Enter the Omni-Notes folder using the command $cd Omni-Notes
+* Check that the branch is up to date by using the command $git status
+* Enter the command $export ANDROID_HOME=/home/fede/Android/Sdk
+* Enter the command $./gradlew assemble
+* Allow a couple minutes for the application to build.
+* View the outputs of the build using the command $ls -l omniNotes/build/outputs/apk
+
+
 To be sure that build environment is fully compliant with the project the following command creates a container with all the needed tools to compile the code:
 
 ```
@@ -112,94 +119,26 @@ To speedup the development more levels of testing are available following the [t
 ```
 Notice that in this case I specified a single flavor to run tests on. This could be a useful and faster approach when you're testing specific flavor features.  
 
-## Contributing
-
-Due to the fact that I'm using [gitflow](https://github.com/nvie/gitflow) as code versioning methodology, you as developer should **always** start working on [develop branch](https://github.com/federicoiosue/Omni-Notes/tree/develop) that contains the most recent changes.
-
-There are many features/improvements that are not on **my** roadmap but someone else could decide to work on them anyway: hunt for issues tagged as [Help Wanted](https://github.com/federicoiosue/Omni-Notes/issues?utf8=✓&q=label%3A"Help+wanted") to find them!
-
-Feel free to add yourself to [contributors.md](https://github.com/federicoiosue/Omni-Notes/blob/develop/CONTRIBUTORS.md) file.
-
-### New feature or improvements contributions
-
-This kind of contributions **must** have screenshots or screencast as demonstration of the new additions.
-
-### Code style
-
-If you plan to manipulate the code then you'll have to do it by following a [specific code style](https://gist.github.com/federicoiosue/dee53e882b3c70d544f8608769eb02fc).
-Also pay attention if you're using any plugin that automatically formats/cleans/rearrange your code and set it to only change that code that you touched and not the whole files.
-
-### Test your code contributions!
-
-All code changes and additions **must** be tested.
-See the [related section](#test) for more informations or this two pull requests comments: [one](https://github.com/federicoiosue/Omni-Notes/pull/646#pullrequestreview-187973443) and [two](https://github.com/federicoiosue/Omni-Notes/pull/683#issuecomment-506206689)
-
-### Forking project
-
-When forking the project you'll have to modify some files that are strictly dependent from my own development / build / third-party-services environment. Files that need some attention are the following:
-
-  - *gradle.properties*: this is overridden by another file with the same name inside the *omniNotes* module. You can do the same or leave as it is, any missing property will let the app gracefully fallback on a default behavior.
-
-## Code quality
-
-A public instance of SonarQube is available both to encourage other developers to improve their code contributions (and existing code obviously) and to move the project even further into transparency and openness.
-
-Checkout for it [here](https://sonarcloud.io/dashboard?id=omni-notes)
-
-Pull requests will be automatically analyzed and rejected if they'll rise the code technical debt.
-
-## Dependencies
-
-They're all listed into the [build.gradle](https://github.com/federicoiosue/Omni-Notes/blob/develop/omniNotes/build.gradle) file but due to the fact that many of the dependences have been customized by me I'd like to say thanks here to the original developers of these great libraries:
-
-* https://github.com/RobotiumTech/robotium
-* https://github.com/LarsWerkman/HoloColorPicker
-* https://github.com/keyboardsurfer/Crouton
-* https://github.com/romannurik/dashclock/wiki/API
-* https://github.com/ACRA/acra
-* https://github.com/Shusshu/Android-RecurrencePicker
-* https://github.com/gabrielemariotti/changeloglib
-* https://github.com/greenrobot/EventBus
-* https://github.com/futuresimple/android-floating-action-button
-* https://github.com/keyboardsurfer
-* https://github.com/bumptech/glide
-* https://github.com/neopixl/PixlUI
-* https://github.com/afollestad/material-dialogs
-* https://github.com/ical4j
-* https://github.com/square/leakcanary
-* https://github.com/pnikosis/materialish-progress
-* https://github.com/apl-devs/AppIntro
-* https://github.com/ReactiveX/RxAndroid
-* https://github.com/artem-zinnatullin/RxJavaProGuardRules
-* https://github.com/tbruyelle/RxPermissions
-* https://github.com/ocpsoft/prettytime
-* https://github.com/piwik/piwik-sdk-android
-* https://github.com/mrmans0n/smart-location-lib
-
-
 ## Mentioned on
 
 [XDA](https://www.xda-developers.com/omni-notes-the-open-source-note-app/)
 [Android Authority](https://www.androidauthority.com/best-note-taking-apps-for-android-205356/)
-[Droid Advisor](https://droidadvisor.com/omni-notes-note-taking-app/)
 [Addictive Tips](https://www.addictivetips.com/android/note-taking-apps-for-android/)
 [Techalook](https://techalook.com/apps/best-sticky-notes-android-iphone/)
 [DZone](https://dzone.com/articles/amazing-open-source-android-apps-written-in-java)
 [Slash Gear](https://www.slashgear.com/best-note-taking-apps-for-android-phones-and-tablets-04529297/)
 [quaap.com](https://quaap.com/D/use-fdroid)
+[Freeappsforme.com](https://freeappsforme.com/productivity-apps-android-ios-2017)
 
 ## Developed with love and passion by
 
-
 * Federico Iosue - [Website](https://federico.iosue.it)
-* [Other contributors](https://github.com/federicoiosue/Omni-Notes/blob/develop/CONTRIBUTORS.md)
-
-
+* [Other contributors](https://github.com/federicoiosue/Omni-Notes/graphs/contributors)
 
 ## License
 
 
-    Copyright 2013-2021 Federico Iosue
+    Copyright 2013-2022 Federico Iosue
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by

SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Security updates are supported for the following application's versions:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 6.2.x   | :white_check_mark: |
+| < 6.2.x   | :x:                |
+
+## Reporting a Vulnerability
+
+Take contact with me through **[email protected]**