Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/compscidr/hello-kotlin-android
"Hello Kotlin-Android" with jacoco, junit5, ktlint, mockk, codecov, dokka, r8, logback-android, papertrail ready to go
https://github.com/compscidr/hello-kotlin-android
android codecov dokka jacoco junit5 kotlin ktlint logback-android mockk papertrail r8
Last synced: 7 days ago
JSON representation
"Hello Kotlin-Android" with jacoco, junit5, ktlint, mockk, codecov, dokka, r8, logback-android, papertrail ready to go
- Host: GitHub
- URL: https://github.com/compscidr/hello-kotlin-android
- Owner: compscidr
- License: apache-2.0
- Created: 2019-12-01T20:47:27.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T05:20:29.000Z (12 days ago)
- Last Synced: 2025-01-08T05:47:17.004Z (10 days ago)
- Topics: android, codecov, dokka, jacoco, junit5, kotlin, ktlint, logback-android, mockk, papertrail, r8
- Language: Kotlin
- Homepage:
- Size: 799 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hello-kotlin-android
[](https://github.com/compscidr/hello-kotlin-android/actions)
[](https://codecov.io/gh/compscidr/hello-kotlin-android)
[](https://ktlint.github.io/)
[](https://opensource.org/licenses/Apache-2.0)
When starting a new project, I always find getting the tools up and running quickly is a pain, so I
wanted something for Kotlin which already had everything setup and working.
This aims to be a starter repo with all of the following tooling setup:
* [Junit5](https://junit.org/junit5/docs/current/user-guide/)
* [Jacoco](https://www.eclemma.org/jacoco/)
* [Github actions](https://github.com/marketplace/actions/gradle-android)
* [Codecov](https://codecov.io/)
* [ktlint](https://ktlint.github.io/)
* [Mockk](https://mockk.io/ANDROID.html)
* [Dokka](https://github.com/Kotlin/dokka)
* [r8](https://android-developers.googleblog.com/2018/11/r8-new-code-shrinker-from-google-is.html)
* [Dagger2](https://medium.com/@elye.project/dagger-2-for-dummies-in-kotlin-with-one-page-simple-code-project-618a5f9f2fe8)
* [Logback Android](https://github.com/tony19/logback-android)
* [Papertrail](https://papertrailapp.com/)
* Unit test examples
* Instrumented test examples
## Codecov notes
Coverage is provided for:
- Instrumented on-device android tests
- JVM unit tests from the android app
- JVM unit tests from the library
They are each uploaded separately, as I had issues with the code cov action providing more than a single report at once. Codecov
can handle the multiple uploads and merge them together anyhow.
## Secrets
Secrets are passed in via `local.properties` or `.env` or via environment variables. There is an example in the GH workflows which shows how to pass in via
`local.properties` and via environment variables. It will also work with a `.env` in the app directory.
## Note about squashing
Do not do squash merges to the staging or production branches, or in the mergebacks to main, or
there will be nothing but trouble. See the following for more details:
https://github.com/orgs/community/discussions/10809
## Staging release
https://github.com/compscidr/hello-kotlin-android/compare/staging...main
## Production release
https://github.com/compscidr/hello-kotlin-android/compare/production...staging
## Merge-backs
NOTE: the mergeback should be a merge commit, not a squash commit or will result in a diff when
comparing branches later on.
Ideally you find no diff:
https://github.com/compscidr/hello-kotlin-android/compare/main...production
https://github.com/compscidr/hello-kotlin-android/compare/main...staging
https://github.com/compscidr/hello-kotlin-android/compare/staging...production
TODO:
* [Firebase Crashlytics](https://firebase.google.com/docs/crashlytics)
* [Jetpack Compose](https://developer.android.com/jetpack/compose)