Kotlin Starter

Directory structure and settings for starting a new Kotlin project.

Gradle Wrapper

Run ./gradlew wrapper --gradle-version=latest to update the wrapper to the latest version.

Plugins & Dependencies

• ktfmt-gradle: ./gradlew ktfmtCheck / ./gradlew ktfmtFormat
• jib: ./gradlew jibDockerBuild --no-configuration-cache / ./gradlew jib --no-configuration-cache (does not yet support configuration cache)
• junit5: ./gradlew test
• dotenv-kotlin: automatically load .env
• kotlinx-coroutines: library support for kotlin coroutines
• kotlin-logging: logging setup with slf4j, logback and a custom logback.xml

Build & Tests

Run ./gradlew build to build and test the project.

Settings for a new GitHub repository

• license "The Unlicense"
• settings / general
  • automatically delete head branches
  • preserve this repository (uncheck)
  • allow auto-merge (for auto-approve-merge GitHub Actions workflow)
• settings / pull request
  • allow squash merging
    • default commit message: pull request title
• settings / branches
  • branche protection rule for main
    • require a pull request before merging
    • pull request requires approval
    • require status checks to pass before merging (add kotlin-build.yml GitHub Actions workflow)
    • require branches to be up-to-date
• settings / actions / general
  • allow gitHub actions to create and approve pull requests (for auto-approve-merge GitHub Actions workflow)

GitHub Actions

• workflow kotlin-build.yml automatically checks for formatting and passing of all tests
• workflow auto-approve-merge.yml automatically approves and merges PRs labeled auto-approve-merge