https://github.com/monstar-lab/sample-android-kotlin

Sample continuous integrated project for Android (Kotlin).
https://github.com/monstar-lab/sample-android-kotlin

android circleci danger kotlin lint

Last synced: about 2 months ago
JSON representation

Sample continuous integrated project for Android (Kotlin).

• Host: GitHub
• URL: https://github.com/monstar-lab/sample-android-kotlin
• Owner: monstar-lab
• Created: 2018-03-14T09:34:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-07T05:52:13.000Z (over 7 years ago)
• Last Synced: 2025-08-09T03:47:11.279Z (about 2 months ago)
• Topics: android, circleci, danger, kotlin, lint
• Language: Kotlin
• Homepage:
• Size: 146 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Sample for Android (Kotlin)

[![CircleCI](https://circleci.com/gh/monstar-lab/sample-android-kotlin.svg?style=svg)](https://circleci.com/gh/monstar-lab/sample-android-kotlin)

This is the sample continuous integrated project for Android (Kotlin).

## What is this repository?

- **Lint**

  - **ktlint**

  - **detekt**

  - **Android Lint**

- **Build**: Configured build setting. e.g. `signingConfigs`, `buildTypes`

- **CircleCI**: Lint, Test, and Build in [CircleCI](https://circleci.com/).

- **PR Comment by Danger**: [Danger](http://danger.systems/ruby/) configuration is included. Lint error comes as PR comment.

## How to setup

1. Setup CircleCI build.

    - Turn "On" "Only build pull requests".

2. Copy or refer to below files. [diff](https://github.com/monstar-lab/sample-android-kotlin/compare/6e14739b8d26c11b66d3e0c11478fbe84b479ebc...master)

    - `.circleci/config.yml`

    - `Dangerfile`

    - `Gemfile`

    - `Gemfile.lock` : If you want newer version, please exec `bundle update`.

    - `build.gradle`

    - `detekt.yml` : Please create default config by `./gradlew detektGenerateConfig`

    - `app/build.gradle`

    - `app/keystores/debug.keystore` : Please get from local.

    - `app/keystores/release.jks` : Please get or create.

2. Set environment variable.

    - `DANGER_GITHUB_API_TOKEN` : token for check bot

    - `ANDROID_KEYSTORE_PASSWORD` : password for release keystore

    - `ANDROID_KEYSTORE_ALIAS` : alias for release keystore

    - `ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD` : alias's password for release keystore

## Memo

### Why integrate both of ktlint and detekt?

I think, 2 tools check different points.

- `ktlint` focus code style. (e.g. position of whitespace, naming rule.)

- `detekt` focus code smell. (e.g. condition is too complex, equals is implemented by hashCode is not.)

### Why configure ktlint and detekt in build.gradle directly?

We have [monstar-lab/gradle-android-ci-check](https://github.com/monstar-lab/gradle-android-ci-check).  

We need to improve that for kotlin setting.

But, currently, ktlint and detekt is developing very rapidly.  

So some interfaces may be changes.  

So now, configure in build.gradle directly.

(In the future, we need improve `monstar-lab/gradle-android-ci-check`.)

## Customize

This repository is targeting for very simple project.

But in real world, we need to work for complex project.

We have some advice for customizing configuration in [Wiki](https://github.com/monstar-lab/sample-android-kotlin/wiki).

Please refer to it.