template-kmp-library
Kotlin multiplatform library template.
Has a baseline setup for a multiplatform library supporting all kotlin targets except android (any help in getting that setup welcome) & deprecated wasm32.
Features
- Native target grouping and shared sourceSets
- Wrapper library module that declares dependencies on all lib modules
- Uniform configuration via conventional plugins
convention.common,convention.library&convention.publishing - Local
testmodule for shared test utilities (a helper function to run coroutine tests in common sourceSet included) - Local
sandboxmodule for easy library consumer side checks - Publication control to avoid multiple publications for targets that can be built on multiple hosts
ktlintplugin with automaticgit-hooksrefreshVersionsplugin for better library version control- Main host for publications can be changed via
gradle.properties#project.mainOSproperty - Gradle Build Scan setup
- GH dependabot setup
- GH release action for platform dependant publications
- GH check action for platform dependant tests on PRs
- Maven Central publishing setup
- GH Packages publishing setup
Setup
Here are some pointers to help you get up and running with this template
Badges
This README contains some useful badges for your project. To tailor them to your artefacts the following changes needs to be made:
Dokka docs- change the link as(http://$GH_USERNAME.github.io/$GH_PROJECT_NAME)Version maven-central - change all occurrences ofdev.petuskato your own group andtemplate-kmp-library` to your root library name
gradle.properties
Have a look at gradle.properties file and change these properties as needed
gh.owner.id- main library developer's usernamegh.owner.name- main library developer's namegh.owner.email- main library developer's emailproject.mainOS- main host to publish cross-platform artefacts from (to avoid duplicate publications)group- artefacts' groupdescription- library descriptionversion- library version (overridden in CI, so doesn't really matter here)
Modules
All the library modules should go to /lib/ directory and be included in /settings.gradle.kts. There are already two sample modules to illustrate how simple the setup is (/lib/template-kmp-library-core & template-kmp-library-dsl). They both contain some sample code and tests that make use of local /test module with testing utilities.
Kotlin Targets
The template comes packed with all kotlin targets preconfigured, however if you want to remove some of them or tweak the config, you only need to make changes as needed in /buildSrc/src/main/kotlin/convention.library.gradle.kts. Removing targets from this file will not break any publications as they're configured on top of pre-registered targets.
GitHub Actions
The template also comes with GH actions to check builds on PRs and publish artefacts when creating a GH release. By default, it'll publish to GH packages and Maven Central. However to fully unlock Maven Central publishing, you'll need to add these secrets to your GH repository. If you want to quickly disable Maven Central publishing, you can toggle it at .github/workflows/release.yml#L80
SIGNING_KEY- GPG signing keySIGNING_KEY_ID- GPG signing key IDSIGNING_PASSWORD- GPG signing key password (if set)SONATYPE_PASSWORD- Sonatype PAT usernameSONATYPE_USERNAME- Sonatype PAT password
Known Issues
- KT-46957 - Commonizer breaks for linuxMips32. This is fixed and scheduled to be released in 1.5.30-M1. However, to make the setup work now, the template is currently using dev build from kotlin snapshot repositories. If you'd like to use a stable kotlin version instead, remove linuxMips32 from linux native target group in
/buildSrc/src/main/kotlin/convention.library.gradle.kts.
0 Dec 6, 2021
207 Jan 4, 2023
3 Oct 27, 2021
5 Jun 25, 2022
14 Nov 4, 2022
0 Oct 6, 2021
0 Jan 7, 2022
1 Dec 25, 2021
0 Dec 14, 2021
0 Jan 3, 2022
0 Feb 2, 2022
25 Dec 26, 2022
7 Oct 30, 2022
8 Oct 18, 2022
2 Sep 27, 2022
0 Dec 5, 2021
0 Jan 7, 2022
1 Feb 7, 2022
7 May 23, 2022