Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit README #39

Open
wants to merge 2 commits into
base: androidx
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 31 additions & 18 deletions .github/workflows/master-release-ci.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,50 @@
name: Master Release CI
# This is a basic workflow to help you get started with Actions

name: CI

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the androidx branch
push:
branches: [ androidx ]
pull_request:
branches:
- androidx
branches: [ androidx ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
lint_test:
name: Clean & Run UT
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2
- uses: actions/setup-java@v1
with:
java-version: '13.x'

# Check code convention
- name: Check code convention
run: ./gradlew ktlint

# Run unit test
- name: Run UT
run: ./gradlew fullCoverageReport

-name: Upload coverage report
# Upload coverage to codec
- name: Upload coverage report
run: bash <(curl -s --retry 10 https://codecov.io/bash) -f "presentation/build/reports/jacoco/fullCoverageReport/fullCoverageReport.xml"

# Build debug
- name: Build debug
command: ./gradlew :presentation:assembleDevelopDebug

- name: upload artifact to Firebase App Distribution
uses: wzieba/[email protected]
with:
appId: ${{ secrets.FIREBASE_APP_ID }}
token: ${{ secrets.FIREBASE_TOKEN }}
groups: testers
file: presentation/build/outputs/apk/develop/debug/presentation-develop-debug.apk
run: ./gradlew :presentation:assembleDevelopDebug

# - name: upload artifact to Firebase App Distribution
# uses: wzieba/[email protected]
# with:
# appId: ${{ secrets.FIREBASE_APP_ID }}
# token: ${{ secrets.FIREBASE_TOKEN }}
# groups: testers
# file: presentation/build/outputs/apk/develop/debug/presentation-develop-debug.apk
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ Introduction

### Base Code
Base code designed one `Activity` and multiple `Fragment`, using `Navigation Component` to UI navigate
Use Dagger2 (version 2.23.2) for Dependencies Injection, You can easily switch to using `Koin` (I suggestion `Dagger` for big, super projects)
Use Hilt (2.38) for Dependencies Injection, You can easily switch to using `Koin` (I suggestion `Hilt` for big, super projects and support multiple features
/modules or dynamic)
Base code
- Has created a flow that handles all of the corner cases, you can easily customize them via `CleanException`, it `extends Throwable`
- Added `Authorization`, `Interceptor` easily handler and `implementations` for your project if needed
Expand Down Expand Up @@ -85,7 +86,7 @@ You can easily write Unit Test up to 70% code coverage lines of code (LOC), if y
* [Glide][90] for image loading
* [Kotlin Coroutines][91] for managing background threads with simplified code and reducing needs for callbacks
* [ReactiveX][92] library for composing asynchronous and event-based programs by using observable sequences.
* [Dagger2][93] for dependencies injection
* [Hilt][93] for dependencies injection
* [Retrofit][94] Type-safe HTTP client for Android
* [EasyPermission][95] is a wrapper library to simplify basic system permissions logic when targeting Android M or higher.

Expand Down