Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tamimattafi/klib-template
Kotlin Multiplatform library template for quick-starts without dealing with boilerplate code
https://github.com/tamimattafi/klib-template
central convention klib kmm kmp kotlin lib library maven maven-central maven-central-portal mpp publishing template
Last synced: about 5 hours ago
JSON representation
Kotlin Multiplatform library template for quick-starts without dealing with boilerplate code
- Host: GitHub
- URL: https://github.com/tamimattafi/klib-template
- Owner: tamimattafi
- License: apache-2.0
- Created: 2024-06-30T11:22:31.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-15T12:59:05.000Z (3 months ago)
- Last Synced: 2024-11-24T17:12:36.919Z (2 months ago)
- Topics: central, convention, klib, kmm, kmp, kotlin, lib, library, maven, maven-central, maven-central-portal, mpp, publishing, template
- Language: Kotlin
- Homepage:
- Size: 77.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kotlin Library Template
Kotlin Multiplatform library template for quick-starts without dealing with boilerplate code
## Introductions
It covers the following boilerplate
1. Publication to local and remote maven repository
2. Multiplatform module conventions
3. Gradle files and build scripts
4. Version catalog
5. Popular gitignore settings
6. GitHub release actions script
7. Sample shared module
## Usage
To use this template all you have to do is to follow these steps:
1. Download a zip file or clone this repository (Don't forget to change git remote settings)
2. Replace `com.attafitamim.kalib` with your package everywhere in the project
3. Replace `klib-template` with your library name everywhere in the project
4. Adjust targets in `MultiplatformConventions.kt`
5. Adjust publishing information in `PublishConventions.kt`
6. Update `README.md` file
That's it! Now you can add your modules, dependencies, adjust targets and start coding!
## Maven central
To publish your library to maven central you need to follow these steps:
1. Crate an account on [central portal](https://central.sonatype.com/)
2. Create a namespace with your package as shown in these [docs](https://central.sonatype.org/register/namespace/)
3. Generate a token as shown [here](https://central.sonatype.org/publish/generate-portal-token/)
4. Generate gpg key using your sonatype email, upload it, then confirm your email using the received link in your inbox
5. Add secrets for publishing as shown [here](https://vanniktech.github.io/gradle-maven-publish-plugin/central/#secrets)
6. Don't forget to add secrets as repository secrets for GitHub actions as shown [here](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)
To publish your artifacts to central portal you can either run `./gradlew publishAllPublicationsToMavenCentralRepository` locally or create a GitHub release
> [!IMPORTANT]
> Don't forget to change publishing version in `PublishConventions.kt`
## Future plans
1. Add testing examples and GitHub actions for the matter
2. Add lint example and GitHub actions for the matter