diff --git a/README.md b/README.md index 635db44..2aa0814 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,39 @@ -[![official project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub) +[![official project](http://jb.gg/badges/official.svg)](https://github.com/JetBrains#jetbrains-on-github) # Multiplatform library template ## What is it? -It is the barebones library project intended to quickly bootstrap a Kotlin Multiplatform library, that is deployable to Maven Central. +This repository contains a simple library project, intended to demonstrate a [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) library that is deployable to [Maven Central](https://central.sonatype.com/). -It has only one function: generate the [Fibonacci sequence](https://en.wikipedia.org/wiki/Fibonacci_sequence) starting from platform-provided numbers. Also, it has a test for each platform just to be sure that tests run. +The library has only one function: generate the [Fibonacci sequence](https://en.wikipedia.org/wiki/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] -(https://kotlinlang.org/docs/jvm-api-guidelines-backward-compatibility.html#tools-designed-to-enforce-backward-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.](https://kotlinlang.org/docs/api-guidelines-introduction.html) +Note that no other actions or tools usually required for the library development are set up, such as [tracking of backwards compatibility](https://kotlinlang.org/docs/jvm-api-guidelines-backward-compatibility.html#tools-designed-to-enforce-backward-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](https://kotlinlang.org/docs/api-guidelines-introduction.html). ## How to publish? This guide describes the steps of publishing a library built with Kotlin Multiplatform to the [Maven Central repository](https://central.sonatype.com/). To publish your library, you’ll need to: -* Set up credentials, including an account on Maven Central and a PGP key to use for signing -* Configure the publishing plugin in your library’s project -* Provide your credentials to the publishing plugin so it can sign and upload your artifacts -* Run the publication task, either locally or using continuous integration +* Set up credentials, including an account on Maven Central and a PGP key to use for signing. +* Configure the publishing plugin in your library’s project. +* Provide your credentials to the publishing plugin so it can sign and upload your artifacts. +* Run the publication task, either locally or using continuous integration. This guide assumes that you are: -- Creating an open-source library +- Creating an open-source library. - Using macOS or Linux. If you are a Windows user, use [GnuPG or Gpg4win](https://gnupg.org/download) to generate a key pair. -- Either not registered on Maven Central yet, or have an existing account that’s suitable for [publishing to the Central Portal](https://central.sonatype.org/publish-ea/publish-ea-guide/) (created after March 12th, 2024, or migrated to the Central Portal by their support) -- Publishing your library in a GitHub repository -- Using GitHub Actions for continuous integration +- Either not registered on Maven Central yet, or have an existing account that’s suitable for [publishing to the Central Portal](https://central.sonatype.org/publish-ea/publish-ea-guide/) (created after March 12th, 2024, or migrated to the Central Portal by their support). +- Publishing your library in a GitHub repository. +- Using GitHub Actions for continuous integration. Most of the steps here are still applicable if you’re using a different setup, but there might be some differences you need to account for. An [important limitation](https://kotlinlang.org/docs/multiplatform-publish-lib.html#host-requirements) is that Apple targets must be built on a machine with macOS. -Throughout this guide, we’ll use the [https://github.com/kotlin-hands-on/fibonacci](https://github.com/kotlin-hands-on/fibonacci) repository as an example. You can refer to the code of this repository to see how the publishing setup works. Don’t forget to **replace all example values with your own** as you’re configuring your project**.** +Throughout this guide, we’ll use the [https://github.com/kotlin-hands-on/fibonacci](https://github.com/kotlin-hands-on/fibonacci) repository as an example. You can refer to the code of this repository to see how the publishing setup works. You **must replace all example values with your own** as you’re configuring your project. ### Prepare accounts and credentials -#### Register a namespace {#register-a-namespace} +#### Register a namespace Artifacts published to Maven repositories are identified by their coordinates, for example `com.example:library:1.0.0`. These coordinates are made up of three parts, separated by colons: the `groupId`, `artifactId`, and `version`. @@ -46,18 +44,18 @@ To get started with publishing to Maven Central, sign in (or create a new accoun **For a GitHub repository** Using your GitHub account to create a namespace is a good option if you don’t own a domain name to use for publication. To create a namespace based on your GitHub account: -1. Enter io.github.`` as your namespace. For example, `io.github.kotlin-hands-on`. +1. Enter `io.github.` as your namespace. For example, `io.github.kotlin-hands-on`. 2. Copy the Verification Key displayed. 3. On GitHub, create a new repository with your GitHub account with the verification key as the repository’s name. For example, `http://github.com/kotlin-hands-on/ex4mpl3c0d`. -4. Navigate back to Maven Central, and click on the Verify Namespace button. After a successful verification, you can delete the repository you’ve created. +4. Navigate back to Maven Central, and click on the Verify Namespace button. After verification succeeds you can delete the repository you’ve created. **For a domain name** To use a domain name that you own as your namespace: -1. Enter your domain as the namespace using reverse-DNS form. If your domain is `example.com`, enter `com.example`. +1. Enter your domain as the namespace using a reverse-DNS form. If your domain is `example.com`, enter `com.example`. 2. Copy the Verification Key displayed. 3. Create a new DNS TXT record with the verification key as its contents. See [Maven Central’s FAQ](https://central.sonatype.org/faq/how-to-set-txt-record/) for more information on how to do this with various domain registrars. -4. Navigate back to Maven Central, and click on the Verify Namespace button. After a successful verification, you can delete the TXT record you’ve created. +4. Navigate back to Maven Central, and click on the Verify Namespace button. After verification succeeds you can delete the TXT record you’ve created. #### Generate a Key Pair @@ -65,41 +63,75 @@ Artifacts published to Maven Central [must be signed with a PGP signature](https To get started with signing, you’ll need to generate a key pair: -* The **private key** is used to sign your artifacts, and should never be shared with others -* The **public key** can be used by others to validate the signature of the artifacts, and should be published +* The **private key** is used to sign your artifacts, and should never be shared with others. +* The **public key** can be used by others to validate the signature of the artifacts, and should be published. The `gpg` tool that can manage signatures for you is available from [their website](https://gnupg.org/download/index.html). You can also install it using package managers such as [Homebrew](https://brew.sh/): -| `brew install gpg` | -| :---- | - +```bash +brew install gpg +``` Generate a key pair with the following command, and fill in the required details when prompted. -| `gpg --full-generate-key` | -| :---- | +```bash +gpg --full-generate-key +``` Choose the recommended defaults for the type of key to be created. You can leave these selections empty and press Enter to accept the default values. -\> At the time of writing, this is `ECC (sign and encrypt)` with `Curve 25519`. Older versions of `gpg` might default to `RSA` with a `3072` bit key size. +> [!NOTE] +> At the time of writing, this is `ECC (sign and encrypt)` with `Curve 25519`. Older versions of `gpg` might default to `RSA` with a `3072` bit key size. Next, you’ll be prompted to set the expiration of the key. If you choose to create a key that automatically expires after a set amount of time, you’ll need to [extend its validity](https://central.sonatype.org/publish/requirements/gpg/#dealing-with-expired-keys) when it expires. You will be asked for your real name, email, and a comment. You can leave the comment empty. -| `Please select what kind of key you want:`
`(1) RSA and RSA`
`(2) DSA and Elgamal`
`(3) DSA (sign only)`
`(4) RSA (sign only)`
`(9) ECC (sign and encrypt) *default*`
`(10) ECC (sign only) `
`(14) Existing key from card`
` Your selection? 9`

`Please select which elliptic curve you want:`
`(1) Curve 25519 *default*`
`(4) NIST P-384`
`(6) Brainpool P-256`
`Your selection? 1 `

`Please specify how long the key should be valid.`
`0 = key does not expire`
` = key expires in n days`
`w = key expires in n weeks`
`m = key expires in n months`
`y = key expires in n years`
`Key is valid for? (0) 0`
`Key does not expire at all`

`Is this correct? (y/N) y `
`GnuPG needs to construct a user ID to identify your key.`| -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +```text +Please select what kind of key you want: + (1) RSA and RSA + (2) DSA and Elgamal + (3) DSA (sign only) + (4) RSA (sign only) + (9) ECC (sign and encrypt) *default* + (10) ECC (sign only) + (14) Existing key from card +Your selection? 9 + +Please select which elliptic curve you want: + (1) Curve 25519 *default* + (4) NIST P-384 + (6) Brainpool P-256 +Your selection? 1 + +Please specify how long the key should be valid. + 0 = key does not expire + = key expires in n days + w = key expires in n weeks + m = key expires in n months + y = key expires in n years +Key is valid for? (0) 0 +Key does not expire at all + +Is this correct? (y/N) y +GnuPG needs to construct a user ID to identify your key. +``` You will be asked for a passphrase to encrypt the key, which you have to repeat. Keep this passphrase stored securely and privately. You’ll be using it later to access the private key. Let’s take a look at the key we’ve created with the following command: -| `gpg --list-keys` | -| :---- | +```bash +gpg --list-keys +``` The output will look something like this: -| `pub ed25519 2024-10-06 [SC] `
` F175482952A225BFC4A07A715EE6B5F76620B385CE`
`uid [ultimate] Your name `
`sub cv25519 2024-10-06 [E]` | -| :---- | +```text +pub ed25519 2024-10-06 [SC] + F175482952A225BFC4A07A715EE6B5F76620B385CE +uid [ultimate] Your name + sub cv25519 2024-10-06 [E] +``` You’ll need to use the long alphanumerical identifier of your key displayed here in the following steps. @@ -109,31 +141,46 @@ You need to [upload the public key to a keyserver](https://central.sonatype.org/ Run the following command to upload your public key using `gpg`, **substituting your own keyid** in the parameters: -| `gpg --keyserver keyserver.ubuntu.com --send-keys F175482952A225BFC4A07A715EE6B5F76620B385CE` | -| :---- | +```bash +gpg --keyserver keyserver.ubuntu.com --send-keys F175482952A225BFC4A07A715EE6B5F76620B385CE +``` -#### Export your private key {#export-your-private-key} +#### Export your private key To let your Gradle project access your private key, you’ll need to export it to a file. Use the following command, **passing in your own keyid** as a parameter. You will be prompted to enter the passphrase you’ve used when creating the key. -| `gpg --armor --export-secret-keys F175482952A225BFC4A07A715EE6B5F76620B385CE > key.gpg` | -| :---- | +```bash +gpg --armor --export-secret-keys F175482952A225BFC4A07A715EE6B5F76620B385CE > key.gpg +``` + +This will create a `key.gpg` file which contains your private key. -This will create a `key.gpg` file which contains your private key. Remember not to share this with anyone. +> [!CAUTION] +> Never share a private key with anyone. If you check the contents of the file, you should see contents similar to this: -| `-----BEGIN PGP PRIVATE KEY BLOCK-----`
`lQdGBGby2X4BEACvFj7cxScsaBpjty60ehgB6xRmt8ayt+zmgB8p+z8njF7m2XiN`
`bpD/h7ZI7FC0Db2uCU4CYdZoQVl0MNNC1Yr56Pa68qucadJhY0sFNiB63KrBUoiO `
`... SQ== =Qh2r`
`-----END PGP PRIVATE KEY BLOCK-----` | -| :---- | +```text +-----BEGIN PGP PRIVATE KEY BLOCK----- +lQdGBGby2X4BEACvFj7cxScsaBpjty60ehgB6xRmt8ayt+zmgB8p+z8njF7m2XiN +... +bpD/h7ZI7FC0Db2uCU4CYdZoQVl0MNNC1Yr56Pa68qucadJhY0sFNiB63KrBUoiO +-----END PGP PRIVATE KEY BLOCK----- +``` -#### Generate the user token {#generate-the-user-token} +#### Generate the user token Your project will also need to authenticate with Maven Central to upload artifacts. On the Central Portal, navigate to the [Account](https://central.sonatype.com/account) page, and click on *Generate User Token*. The output will look like the example below, containing a username and a password. Store this information securely, as it can’t be viewed again on the Central Portal. If you lose these credentials, you’ll need to generate new ones later. -| ``
` ${server}`
` l3nfaPmz`
` `
`` | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +```xml + + ${server} + l3nfaPmz + gh9jT9XfnGtUngWTZwTu/8241keYdmQpipqLPRKeDLTh + +``` ### Configure the project @@ -143,8 +190,13 @@ If you started developing your library from a template project, this is a good t If you have an Android target in your project, you should follow the [steps to prepare your Android library release](https://developer.android.com/build/publish-library/prep-lib-release). This, at a minimum, requires you to [specify an appropriate namespace](https://developer.android.com/build/publish-library/prep-lib-release#choose-namespace) for your library, so that a unique R class will be generated when their resources are compiled. Notice that the namespace is different from the Maven namespace created in the [Register a namespace](#register-a-namespace) section above. -| `android {`
` namespace = "io.github.kotlinhandson.fibonacci"`
`}` | -|:-----------------------------------------------------------------------------| +```kotlin +// build.gradle.kts + +android { + namespace = "io.github.kotlinhandson.fibonacci" +} +``` #### Set up the publishing plugin @@ -152,15 +204,55 @@ This guide uses [vanniktech/gradle-maven-publish-plugin](https://github.com/vann To add the plugin to your project, add the following line in the plugins block, in your library module’s `build.gradle.kts` file: -| `plugins {`
` id("com.vanniktech.maven.publish") version "0.29.0" `
`}` | -| :---- | +```kotlin +// build.gradle.kts + +plugins { + id("com.vanniktech.maven.publish") version "0.29.0" +} +``` *Note: for the latest available version of the plugin, check its [releases page](https://github.com/vanniktech/gradle-maven-publish-plugin/releases).* In the same file, add the following configuration. Customize all these values appropriately for your library. -| `mavenPublishing {`
` publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)`
` signAllPublications()`
` coordinates("io.github.kotlin-hands-on", "fibonacci", "1.0.8")`
` pom {`
` name = "Fibonacci library"`
` description = "A mathematics calculation library."`
` inceptionYear = "2024"`
` url = "https://github.com/kotlin-hands-on/fibonacci/"`
` licenses {`
` license {`
` name = "The Apache License, Version 2.0"`
` url = "http://www.apache.org/licenses/LICENSE-2.0.txt"`
` distribution = "http://www.apache.org/licenses/LICENSE-2.0.txt"`
` }`
` }`
` developers {`
` developer {`
` id = "kotlin-hands-on"`
` name = "Kotlin Developer Advocate"`
` url = "https://github.com/kotlin-hands-on/"`
` }`
` }`
` scm {`
` url = "https://github.com/kotlin-hands-on/fibonacci/"`
` connection "scm:git:git://github.com/kotlin-hands-on/fibonacci.git"`
` developerConnection = "scm:git:ssh://git@github.com/kotlin-hands-on/fibonacci.git"`
` }`
` }`
`}` | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +```kotlin +// build.gradle.kts + +mavenPublishing { + publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL) + + signAllPublications() + + coordinates(group.toString(), "fibonacci", version.toString()) + + pom { + name = "Fibonacci library" + description = "A mathematics calculation library." + inceptionYear = "2024" + url = "https://github.com/kotlin-hands-on/fibonacci/" + licenses { + license { + name = "The Apache License, Version 2.0" + url = "https://www.apache.org/licenses/LICENSE-2.0.txt" + distribution = "https://www.apache.org/licenses/LICENSE-2.0.txt" + } + } + developers { + developer { + id = "kotlin-hands-on" + name = "Kotlin Developer Advocate" + url = "https://github.com/kotlin-hands-on/" + } + } + scm { + url = "https://github.com/kotlin-hands-on/fibonacci/" + connection = "scm:git:git://github.com/kotlin-hands-on/fibonacci.git" + developerConnection = "scm:git:ssh://git@github.com/kotlin-hands-on/fibonacci.git" + } + } +} +``` Note that it’s also possible to use Gradle properties instead. @@ -179,16 +271,43 @@ You can set up continuous integration which builds and publishes your library fo To get started, add the following workflow to your repository, in the `.github/workflows/publish.yml` file. -| `name: Publish`
` on:`
` release:`
` types: [released, prereleased]`
` jobs:`
` publish:`
` name: Release build and publish`
` runs-on: macOS-latest`
` steps:`
` - name: Check out code`
` uses:`
` actions/checkout@v4`
` - name: Set up JDK 21`
` uses:`
` actions/setup-java@v4`
` with:`
` distribution: 'zulu'`
` java-version: 21`
` - name: Publish to MavenCentral`
` run: ./gradlew publishToMavenCentral --no-configuration-cache`
` # Note: Disable Configuration Cache because of https://github.com/gradle/gradle/issues/22779`
` env:`
` ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}`
` ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}`
` ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}`
` ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}`
` ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_KEY_CONTENTS }}` | -| :---- | +```yaml +# .github/workflows/publish.yml + +name: Publish +on: + release: + types: [released, prereleased] +jobs: + publish: + name: Release build and publish + runs-on: macOS-latest + steps: + - name: Check out code + uses: actions/checkout@v4 + - name: Set up JDK 21 + uses: actions/setup-java@v4 + with: + distribution: 'zulu' + java-version: 21 + - name: Publish to MavenCentral + run: ./gradlew publishToMavenCentral --no-configuration-cache + env: + ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }} + ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }} + ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }} + ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} + ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_KEY_CONTENTS }} +``` After committing and pushing this change, this workflow will run automatically when you create a release (including a pre-release) in the GitHub repository hosting your project. It checks out the current version of your code, sets up a JDK, and then runs the `publishToMavenCentral` Gradle task. -\> Alternatively, you could configure the workflow to [trigger when a tag is pushed](https://stackoverflow.com/a/61892639) to your repository. - -\> The script above disables Gradle [configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html) for the publication task by adding `--no-configuration-cache` to the Gradle command, as the publication plugin does not support it (see this [open issue](https://github.com/gradle/gradle/issues/22779)). - -\> Reminder: When using `publishToMavenCentral`, you’ll still need to check and release your deployment manually on the website, as described in the previous section. You may use `publishAndReleaseToMavenCentral` instead for a fully automated release. +> [!NOTE] +> Alternatively, you could configure the workflow to [trigger when a tag is pushed](https://stackoverflow.com/a/61892639) to your repository. +> +> The script above disables Gradle [configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html) for the publication task by adding `--no-configuration-cache` to the Gradle command, as the publication plugin does not support it (see this [open issue](https://github.com/gradle/gradle/issues/22779)). +> +> Reminder: When using `publishToMavenCentral`, you’ll still need to check and release your deployment manually on the website, as described in the previous section. You may use `publishAndReleaseToMavenCentral` instead for a fully automated release. This action will need your signing details and your Maven Central credentials. These will be configured as GitHub Actions secrets in the next section. The configuration of the workflow above takes these secrets and places them into environment variables, which will make them available to the Gradle build automatically. @@ -203,9 +322,7 @@ Click on the `New repository secret` button, and add the following secrets: - `SIGNING_PASSWORD` is the passphrase you’ve provided when generating your signing key. - `GPG_KEY_CONTENTS` should contain the contents of your GPG private key file, which you’ve created earlier in the [Export your private key](#export-your-private-key) section. -# - -![](/images/image5.png) +![](/images/github_secrets.png) Note again that the names used for these secrets must match those used by the workflow that accesses their values. @@ -215,41 +332,50 @@ With the workflow and secrets set up, you’re now ready to [create a release](h Go to your GitHub repository’s main page, and click on Releases in the menu in the right sidebar. -![](/images/image3.png) +![](/images/github_releases.png) Click *Draft a new release*. -![](/images/image7.png) +![](/images/draft_release.png) Each release creates a new tag. Set the name for the tag to be created, and set a name for the release (these may be identical). Note that setting a version here does not change the version of your coordinates configured in your `build.gradle.kts` file, so you should update that version before creating a new release. -![](/images/image4.png) +![](/images/create_release_and_tag.png) Double-check the branch you want to target with the release (especially if you want to release from a branch that’s different from your default), and add appropriate release notes for your new version. The checkboxes below allow you to mark a release as a pre-release (useful for alpha, beta, or RC versions of a library), or to set the release as the latest available one: -![](/images/image6.png) +![](/images/release_settings.png) Click the *Publish release* button to create the new release. This will immediately show up on your GitHub repository’s main page. -Click the Actions tab on the top of your GitHub repository. Here you’ll see the new workflow that was triggered by the GitHub release. Click it to see the outputs of the publication task. +Click the Actions tab on the top of your GitHub repository. Here you’ll see the new workflow was triggered by the GitHub release. Click it to see the outputs of the publication task. After this task completes successfully, navigate to the [Deployments](https://central.sonatype.com/publishing/deployments) dashboard. You should see a new deployment here. This deployment will be in the *pending* and *validating* states for some time while Maven Central performs checks on it. Once your deployment moves to a *validated* state, you should see that it contains all the artifacts you’ve uploaded. If everything looks correct, click the *Publish* button to release these artifacts. -![](/images/image2.png) +![](/images/published_on_maven_central.png) -Note that it will take some time (about 15-30 minutes, usually) after the release for the artifacts to be available publicly on Maven Central. Also note that the library may be available for use before the website is updated. +Note that it will take some time (about 15–30 minutes, usually) after the release for the artifacts to be available publicly on Maven Central. +Also note that the library may be available for use before they are indexed on [the Maven Central website](https://central.sonatype.com/). -There’s also another task available which both uploads and releases the artifacts automatically once the the deployment is verified, without having to manually release them on the website: +There’s also another task available which both uploads and releases the artifacts automatically once the deployment is verified, without having to manually release them on the website: -| `./gradlew publishAndReleaseToMavenCentral` | -| :---- | +```bash +./gradlew publishAndReleaseToMavenCentral +``` **Et voilà, you have successfully published your library to Maven Central.** +# Next steps +- Share your library with the Kotlin Community in the `#feed` channel in the [Kotlin Slack](https://kotlinlang.slack.com/) (To sign up visit https://kotl.in/slack.) +- Add [shield.io badges](https://shields.io/badges/maven-central-version) to your README. +- Create a documentation site for your project using [Writerside](https://www.jetbrains.com/writerside/). +- Share API documentation for your project using [Dokka](https://kotl.in/dokka). +- Add [Renovate](https://docs.renovatebot.com/) to automatically update dependencies. + # Other resources * [Publishing via the Central Portal](https://central.sonatype.org/publish-ea/publish-ea-guide/) * [Gradle Maven Publish Plugin \- Publishing to Maven Central](https://vanniktech.github.io/gradle-maven-publish-plugin/central/) \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index 80d16f2..f2cb9f1 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,5 +1,5 @@ plugins { - alias(libs.plugins.androidLibrary).apply(false) - alias(libs.plugins.kotlinMultiplatform).apply(false) - alias(libs.plugins.publish) apply false -} + alias(libs.plugins.androidLibrary) apply false + alias(libs.plugins.kotlinMultiplatform) apply false + alias(libs.plugins.vanniktech.mavenPublish) apply false +} \ No newline at end of file diff --git a/fibonacci/build.gradle.kts b/fibonacci/build.gradle.kts index e629047..89f5bb9 100644 --- a/fibonacci/build.gradle.kts +++ b/fibonacci/build.gradle.kts @@ -2,15 +2,15 @@ import com.vanniktech.maven.publish.SonatypeHost import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi import org.jetbrains.kotlin.gradle.dsl.JvmTarget -group = "io.github.kotlin-hands-on" -version = "1.0.8" - plugins { alias(libs.plugins.kotlinMultiplatform) alias(libs.plugins.androidLibrary) - alias(libs.plugins.publish) + alias(libs.plugins.vanniktech.mavenPublish) } +group = "io.github.kotlin-hands-on" +version = "1.0.8" + kotlin { jvm() androidTarget { @@ -52,7 +52,7 @@ mavenPublishing { signAllPublications() - coordinates("io.github.kotlin-hands-on", "fibonacci", "1.0.8") + coordinates(group.toString(), "fibonacci", version.toString()) pom { name = "Fibonacci library" diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 9a44476..ea4b3b2 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -7,9 +7,8 @@ android-compileSdk = "34" [libraries] kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" } -nexus-publish = { module = "io.github.gradle-nexus.publish-plugin:io.github.gradle-nexus.publish-plugin.gradle.plugin", version.ref = "nexus-publish" } [plugins] androidLibrary = { id = "com.android.library", version.ref = "agp" } kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" } -publish = { id = "com.vanniktech.maven.publish", version = "0.29.0" } \ No newline at end of file +vanniktech-mavenPublish = { id = "com.vanniktech.maven.publish", version = "0.29.0" } \ No newline at end of file diff --git a/images/image4.png b/images/create_release_and_tag.png similarity index 100% rename from images/image4.png rename to images/create_release_and_tag.png diff --git a/images/image7.png b/images/draft_release.png similarity index 100% rename from images/image7.png rename to images/draft_release.png diff --git a/images/image3.png b/images/github_releases.png similarity index 100% rename from images/image3.png rename to images/github_releases.png diff --git a/images/image5.png b/images/github_secrets.png similarity index 100% rename from images/image5.png rename to images/github_secrets.png diff --git a/images/image1.png b/images/image1.png deleted file mode 100644 index cf4efb0..0000000 Binary files a/images/image1.png and /dev/null differ diff --git a/images/image2.png b/images/published_on_maven_central.png similarity index 100% rename from images/image2.png rename to images/published_on_maven_central.png diff --git a/images/image6.png b/images/release_settings.png similarity index 100% rename from images/image6.png rename to images/release_settings.png