Skip to content

Repository files navigation

official project

Multiplatform library template

What is it?

This repository contains a simple library project, intended to demonstrate a Kotlin Multiplatform library that is deployable to Maven Central.

The library has only one function: generate the Fibonacci sequence starting from platform-provided numbers. Also, it has a test for each platform just to be sure that tests run.

Note that no other actions or tools usually required for the library development are set up, such as tracking of backwards compatibility, explicit API mode, licensing, contribution guideline, code of conduct and others. You can find a guide for best practices for designing Kotlin libraries here.

Guide

Please find the detailed guide here.

Publishing this library to Maven Central

  1. Put credentials in your user-level Gradle properties file (~/.gradle/gradle.properties), not in this repository:
    • mavenCentralUsername=<your-central-portal-username>
    • mavenCentralPassword=<your-central-portal-token>
    • signing.keyId=<your-pgp-key-id>
    • signing.key=<ascii-armored-private-key-content>
    • The signing key passphrase property required by Gradle signing
  2. Set the release version in library/build.gradle.kts.
  3. Run:
    • ./gradlew :library:publishAndReleaseToMavenCentral
  4. Verify published coordinates:
    • io.github.raulhuertas:library:<version>

Check for gradle commands with a prefix

(e.g checkPomFileFile...)

 .\gradlew tasks --all | Select-String checkPomFileFor

Other resources

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages