https://github.com/christian-draeger/kotlin-library-template

A template project to jumpstart the creation and publishing of new Kotlin multiplatform libraries.
https://github.com/christian-draeger/kotlin-library-template

kotlin kotlin-multiplatform kotlin-multiplatform-library kotlin-multiplatform-sample library-template maven-publish

Last synced: about 1 month ago
JSON representation

A template project to jumpstart the creation and publishing of new Kotlin multiplatform libraries.

• Host: GitHub
• URL: https://github.com/christian-draeger/kotlin-library-template
• Owner: christian-draeger
• License: mit
• Created: 2024-12-18T15:00:58.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-30T17:00:24.000Z (about 1 month ago)
• Last Synced: 2024-12-30T18:17:53.226Z (about 1 month ago)
• Topics: kotlin, kotlin-multiplatform, kotlin-multiplatform-library, kotlin-multiplatform-sample, library-template, maven-publish
• Language: Kotlin
• Homepage:
• Size: 102 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 [![CI](https://github.com/christian-draeger/kotlin-library-template/actions/workflows/build.yml/badge.svg)](https://github.com/christian-draeger/kotlin-library-template/actions/workflows/build.yml) ![Maven Central Version](https://img.shields.io/maven-central/v/codes.draeger/kotlin-library-template-example?logo=sonatype&label=Release)

A template project to jumpstart the creation and publishing of new Kotlin libraries.

## Publishing

### To Maven Local

```bash

./gradlew publishToMavenLocal

```

### To Maven Central

The Project contains a github action to publish the library to maven central.

This github action requires the following secrets to be set:

- `MAVEN_CENTRAL_USERNAME`

- `MAVEN_CENTRAL_PASSWORD`

- `SIGNING_IN_MEMORY_KEY`

- `SIGNING_IN_MEMORY_KEY_ID`

- `SIGNING_IN_MEMORY_KEY_PASSWORD`

#### How to get the signing key

Please change the `` placeholder in the following command to your signing key id.

```bash

gpg --export-secret-keys --armor  | grep -v '\-\-' | grep -v '^=.' | tr -d '\n'

```