kotlin-jvm-library

A template repository for Kotlin/JVM library projects.

Usage

After creating a new repository from this template, do the following:

• In the repository
  • Replace value of rootProject.name in settings.gradle.kts.
  • Replace value of group in build.gradle.kts.
  • Rename package in src/main/kotlin and src/test/kotlin.
  • Remove api/kotlin-jvm-library.api and run ./gradlew apiDump.
  • Replace module and package documentation in Module.md.
  • Replace project description in README.md.
• On GitHub
  • Generate a new Gradle encryption key with openssl rand -base64 16 and set it as the action secret GRADLE_ENCRYPTION_KEY. See also here.
  • Create a personal access token (PAT) with write access to contents and pull requests and set it as the action secret PULL_REQUEST_TOKEN. See also here.
  • Enable repository setting Allow GitHub Actions to create and approve pull requests.
  • Set GitHub Pages Source to GitHub Actions.