Merge pull request #24 from nimblehq/release/0.1.0

Release - 0.1.0

.github/ISSUE_TEMPLATE/bug_template.md

@@ -7,14 +7,14 @@ labels: "type : bug"
 
 ## Issue
 
-Describe the issue you are facing. Show us the implementation: screenshots, GIFs, etc.
+Describe the issue you are facing. Show us the implementation: screenshots, gif, etc.
 
 ## Expected
 
-Describe what should be the correct behavior.
+Describe what should be the correct behaviour.
 
 ## Steps to reproduce
 
-1. 
-2. 
-3. 
+1.
+2.
+3.

.github/ISSUE_TEMPLATE/chore_template.md

@@ -1,13 +1,13 @@
 ---
 name: "Chore"
-about: "Open a chore issue for a minor update."
+about: "Open a Chore for minor update."
 title: "Update "
 labels: "type : chore"
 ---
 
 ## Why
 
-Describe the update in detail and why it is needed.
+Describe the update details and why it's needed.
 
 ## Who Benefits?
 

.github/ISSUE_TEMPLATE/feature_template.md

@@ -7,7 +7,7 @@ labels: "type : feature"
 
 ## Why
 
-Describe the big picture of the feature and why it is needed.
+Describe the big picture of the feature and why it's needed.
 
 ## Who Benefits?
 

.github/ISSUE_TEMPLATE/rfc_template.md

@@ -0,0 +1,28 @@
+---
+name: "Request For Comments (RFC)"
+about: "You have an idea on how to improve our processes. Propose your idea so that the team can provide feedback."
+title: "RFC: "
+labels: "type : rfc"
+---
+
+## Issue
+
+Describe the issue the team is currently facing. Provide as much content as possible.
+
+## Solution
+
+Describe the solution you are prescribing for the issue
+
+## Who Benefits?
+
+Describe who will be the beneficiaries e.g. everyone, specific chapters, clients...
+
+## What's Next?
+
+Provide an actionable list of things that must happen in order to implement the solution:
+
+- [ ]
+- [ ]
+- [ ]
+
+Using a poll is encouraged to gather feedback on the RFA 👉 Use this tool: https://gh-polls.com/

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,17 @@
-https://github.com/nimblehq/git-template/issues/??
+Note: for a release PR, append this parameter `?template=release_template.md` to the current URL to apply the release PR template, e.g. `{Github PR URL}?template=release_template.md`
+
+--
+
+https://github.com/nimblehq/jetpack-compose-crypto/issues/??
 
 ## What happened 👀
 
 Describe the big picture of your changes here to communicate to the team why we should accept this pull request.
 
 ## Insight 📝
 
-Describe in detail how to test the changes, which solution you tried but did not go with, referenced documentation is welcome as well.
+Describe in details how to test the changes, which solution you tried but did not go with, referenced documentation is welcome as well.
 
 ## Proof Of Work 📹
 
-Show us the implementation: screenshots, GIFs, etc.
+Show us the implementation: screenshots, gif, etc.

.github/PULL_REQUEST_TEMPLATE/release_template.md

@@ -1,4 +1,4 @@
-Link to the milestone on Github e.g. https://github.com/nimblehq/git-templates/milestone/41?closed=1
+Link to the milestone on Github e.g. https://github.com/nimblehq/jetpack-compose-crypto/milestone/1?closed=1
 or
 Link to the project management tool for the release
 
@@ -7,8 +7,8 @@ Link to the project management tool for the release
 Provide the ID and title of the issue in the section for each type (feature, chore and bug). The link is optional.
 
 - [ch1234] As a user, I can log in
-or
-- [[ch1234](https://github.com/nimblehq/git-templates/issues/1234)] As a user, I can log in
+  or
+- [[ch1234](https://github.com/nimblehq/jetpack-compose-crypto/issues/1234)] As a user, I can log in
 
 ## Chores
 - Same structure as in  ## Feature

.github/workflows/deploy_to_firebase_app_distribution.yml

@@ -0,0 +1,69 @@
+name: Deploy staging to Firebase App Distribution
+
+on:
+  # Trigger the workflow on push action in develop branch.
+  # So it will trigger when the PR of the feature/chore/bugfix branch was merged.
+  push:
+    branches:
+      - develop
+
+jobs:
+  deploy_staging_to_firebase_app_distribution:
+    name: Deploy staging to Firebase App Distribution
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+
+      - name: Set up timezone
+        uses: zcong1993/setup-timezone@master
+        with:
+          timezone: Asia/Bangkok
+
+      - name: Checkout source code
+        uses: actions/[email protected]
+
+      - name: Cache Gradle
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.gradle/caches/modules-*
+            ~/.gradle/caches/jars-*
+            ~/.gradle/caches/build-cache-*
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Run Detekt
+        run: ./gradlew detekt
+
+      - name: Archive Detekt reports
+        uses: actions/upload-artifact@v2
+        with:
+          name: DetektReports
+          path: build/reports/detekt/
+
+      - name: Run unit tests and Jacoco
+        run: ./gradlew jacocoTestReport
+
+      - name: Archive code coverage reports
+        uses: actions/upload-artifact@v2
+        with:
+          name: CodeCoverageReports
+          path: |
+            app/build/reports/jacoco/jacocoTestReport/
+            data/build/reports/jacoco/jacocoTestReport/
+
+      - name: Build debug APK
+        run: ./gradlew assembleDebug
+
+      - name: Deploy staging to Firebase
+        uses: wzieba/Firebase-Distribution-Github-Action@v1
+        with:
+          appId: ${{secrets.FIREBASE_APP_ID_STAGING}}
+          token: ${{secrets.FIREBASE_TOKEN}}
+          groups: Dev
+          file: app/build/outputs/apk/staging/debug/app-staging-debug.apk

.github/workflows/review_pull_request.yml

@@ -0,0 +1,67 @@
+name: Review pull request
+
+on:
+  pull_request:
+    types: [ opened, edited, reopened, synchronize ]
+
+jobs:
+  review_pull_request:
+    name: Review pull request
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+
+      - name: Checkout source code
+        uses: actions/[email protected]
+
+      - name: Cache Gradle
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.gradle/caches/modules-*
+            ~/.gradle/caches/jars-*
+            ~/.gradle/caches/build-cache-*
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Run Detekt
+        run: ./gradlew detekt
+
+      - name: Run Android Lint
+        run: ./gradlew lint
+
+      - name: Run unit tests and Jacoco
+        run: ./gradlew jacocoTestReport
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+
+      - name: Cache gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+
+      - name: Install Bundle and check environment versions
+        run: |
+          echo 'Install Bundle'
+          bundle config path vendor/bundle
+          bundle install
+          echo 'Check environment setup versions'
+          ruby --version
+          gem --version
+          bundler --version
+
+      - name: Run Danger
+        env:
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: bundle exec danger

.gitignore

@@ -1,36 +1,52 @@
-*.gem
-*.rbc
-/.config
-/.idea
-/coverage/
-/InstalledFiles
-/node_modules
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+# Created by .ignore support plugin (hsz.mobi)
+### Android template
+# Built application files
+*.apk
+*.ap_
+
+# Files for the ART/Dalvik VM
+*.dex
+
+# Java class files
+*.class
+
+# Generated files
+bin/
+gen/
+out/
+.DS_Store
+
+# Gradle files
+.gradle/
+/build
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Proguard folder generated by Eclipse
+proguard/
+
+# Log Files
+*.log
+
+
+# Android Studio captures folder
+captures/
+
+# Intellij
+*.iml
+.idea/*
+
+# Keystore files
+secret/
+
+# External native build folder generated in Android Studio 2.2 and later
+.externalNativeBuild
+
+# Code coverage
+jacoco.exec
+
+# Google services
+google-services.json
+# Keystore
+config/release.keystore