github-actions-sample 🤖

This is a sample repository used to setup Github Actions during the talk Devops-ify your life with Github Actions

This repo contains just a dummy Android App. The Android App is inside the /app folder.

To run all the checks you can simply run:

./gradlew check

To create a release APK you can simply run

./gradlew assembleRelease

The APK will be available in:

./app/build/outputs/apk/release/app-release-unsigned.apk

Template 📦

This repository has been created from the kotlin-android-template Github Template repo.

Features 🎨

• 100% Kotlin-only template.
• 3 Sample modules (Android app, Android library, Kotlin library).
• Sample Espresso, Instrumentation & JUnit tests.
• 100% Gradle Kotlin DSL setup.
• Dependency versions managed via buildSrc.
• CI Setup with GitHub Actions.
• Kotlin Static Analysis via ktlint and detekt.
• Publishing Ready.
• Issues Template (bug report + feature request)
• Pull Request Template.

Gradle Setup 🐘

This template is using Gradle Kotlin DSL as well as the Plugin DSL to setup the build.

Dependencies are centralized inside the Dependencies.kt file in the buildSrc folder. This provides convenient auto-completion when writing your gradle files.

Static Analysis 🔍

This template is using ktlint with the ktlint-gradle plugin to format your code. To reformat all the source code as well as the buildscript you can run the ktlintFormat gradle task.

This template is also using detekt to analyze the source code, with the configuration that is stored in the detekt.yml file (the file has been generated with the detektGenerateConfig task).

CI ⚙️

This template is using GitHub Actions as CI. You don't need to setup any external service and you should have a running CI once you start using this template.

There are currently the following workflows available:

• Validate Gradle Wrapper - Will check that the gradle wrapper has a valid checksum
• Pre Merge Checks - Will run the build, check and publishToMavenLocal tasks.

Publishing 🚀

The template is setup to be ready to publish a library/artifact on a Maven Repository. If you're using JitPack, you don't need any further configuration and you can just configure the repo on JitPack. If you're using another repository (MavenCentral/JCenter/etc.), you need to specify the publishing coordinates.

Contributing 🤝

Feel free to open a issue or submit a pull request for any bugs/improvements.