Distribute Clikt on all Kotlin MPP desktop platforms (#127)

This includes JVM, NodeJS, Linux, Windows, and MacOS.

With the exception of some [Kotlin compiler bugs](https://youtrack.jetbrains.com/issue/KT-33294), all functionality is implemented on all platforms.

Since JitPack does not currently support MPP projects, snapshots will now be distributed through Maven Central.

Author: ajalt

.github/workflows/publish.yml

@@ -0,0 +1,81 @@
+name: build
+
+on:
+   push:
+      paths-ignore:
+         - 'doc/**'
+         - '*.md'
+      branches:
+         - master
+
+jobs:
+   build:
+      strategy:
+         matrix:
+            os: [macOS-latest, windows-latest, ubuntu-latest]
+
+      runs-on: ${{matrix.os}}
+
+      steps:
+         -  name: Checkout the repo
+            uses: actions/checkout@v2
+
+         -  name: Run ubuntu tests
+            if: matrix.os == 'ubuntu-latest'
+            run: ./gradlew check
+
+         -  name: Run windows tests
+            if: matrix.os == 'windows-latest'
+            run: ./gradlew mingwX64Test
+
+         -  name: Run macOS tests
+            if: matrix.os == 'macOS-latest'
+            run: ./gradlew macosX64Test
+
+         -  name: Bundle the build report
+            if: failure()
+            run: find . -type d -name 'reports' | zip -@ -r build-reports.zip
+
+         -  name: Upload the build report
+            if: failure()
+            uses: actions/upload-artifact@master
+            with:
+               name: error-report
+               path: build-reports.zip
+
+   deploy-mac-and-linux:
+      needs: build
+      runs-on: macOS-latest
+      steps:
+         -  name: Checkout the repo
+            uses: actions/checkout@v2
+         -  name: Set build tag
+            run: echo ::set-env name=BUILD_TAG::$(git tag --points-at HEAD)
+         -  name: Set build number
+            run: echo ::set-env name=BUILD_NUMBER::$(git rev-list --count HEAD)
+         -  name: deploy to sonatype snapshots
+            run: ./gradlew publish
+            env:
+               ORG_GRADLE_PROJECT_SONATYPE_USERNAME: ${{ secrets.ORG_GRADLE_PROJECT_SONATYPE_USERNAME }}
+               ORG_GRADLE_PROJECT_SONATYPE_PASSWORD: ${{ secrets.ORG_GRADLE_PROJECT_SONATYPE_PASSWORD }}
+               ORG_GRADLE_PROJECT_signingKey: ${{ secrets.ORG_GRADLE_PROJECT_signingKey }}
+
+   deploy-windows:
+      needs: build
+      runs-on: windows-latest
+      steps:
+         -  name: Checkout the repo
+            uses: actions/checkout@v2
+         -  name: Set build tag
+            run: echo ::set-env name=BUILD_TAG::$(git tag --points-at HEAD)
+         -  name: Set build number
+            run: echo ::set-env name=BUILD_NUMBER::$(git rev-list --count HEAD)
+         -  name: deploy to sonatype snapshots
+            run: ./gradlew publishMingwX64PublicationToMavenRepository
+            env:
+               ORG_GRADLE_PROJECT_SONATYPE_USERNAME: ${{ secrets.ORG_GRADLE_PROJECT_SONATYPE_USERNAME }}
+               ORG_GRADLE_PROJECT_SONATYPE_PASSWORD: ${{ secrets.ORG_GRADLE_PROJECT_SONATYPE_PASSWORD }}
+               ORG_GRADLE_PROJECT_signingKey: ${{ secrets.ORG_GRADLE_PROJECT_signingKey }}
+
+env:
+   GRADLE_OPTS: -Dorg.gradle.configureondemand=true -Dorg.gradle.parallel=true -Dkotlin.incremental=false -Dorg.gradle.jvmargs="-Xmx3g -XX:MaxPermSize=2048m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8"

.github/workflows/PR.yml renamed to .github/workflows/test.yml

@@ -6,13 +6,19 @@ on:
       - 'docs/**'
       - '*.md'
 
+
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [macOS-latest, windows-latest, ubuntu-latest]
+
+    runs-on: ${{matrix.os}}
 
     steps:
       - name: Checkout the repo
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
+
       - name: Cache gradle
         uses: actions/cache@v1
         with:
@@ -21,8 +27,15 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gradle-
 
-      - name: Run tests
-        run: ./gradlew build
+      - name: Run ubuntu tests
+        if: matrix.os == 'ubuntu-latest'
+        run: ./gradlew check
+      - name: Run windows tests
+        if: matrix.os == 'windows-latest'
+        run: ./gradlew mingwX64Test
+      - name: Run macOS tests
+        if: matrix.os == 'macOS-latest'
+        run: ./gradlew macosX64Test
 
       - name: Bundle the build report
         if: failure()

LICENSE.txt

@@ -3,9 +3,8 @@
     <p><img src="docs/img/animation.png"></p>
 </h1>
 
-Clikt *(pronounced "clicked")* is a Kotlin library that makes writing
-command line interfaces simple and intuitive. It's the "Command Line
-Interface for Kotlin".
+Clikt *(pronounced "clicked")* is a multiplatform Kotlin library that makes writing command line
+interfaces simple and intuitive. It's the "Command Line Interface for Kotlin".
 
 It is designed to make the process of writing command line tools effortless
 while supporting a wide variety of use cases and allowing advanced
@@ -16,9 +15,9 @@ Clikt has:
  * arbitrary nesting of commands
  * composable, type safe parameter values
  * support for a wide variety of command line interface styles
+ * multiplatform packages for JVM, NodeJS, and native Linux, Windows and MacOS 
 
- What does it look like? Here's a complete example of a simple Clikt
- program:
+ What does it look like? Here's a complete example of a simple Clikt program:
 
 ```kotlin
 class Hello : CliktCommand() {
@@ -35,7 +34,7 @@ class Hello : CliktCommand() {
 fun main(args: Array<String>) = Hello().main(args)
 ```
 
- And here's what it looks like when run:
+And here's what it looks like when run:
 
 ```
  $ ./hello --count=3
@@ -75,17 +74,31 @@ them with the included [`runsample` script](runsample).
 
 ## Installation
 
-Clikt is distributed through 
-[Maven Central](https://mvnrepository.com/artifact/com.github.ajalt/clikt),
-[Jcenter](https://bintray.com/ajalt/maven/clikt) and
-[Jitpack](https://jitpack.io/#ajalt/clikt).
+Clikt is distributed through [Maven Central](https://search.maven.org/artifact/com.github.ajalt/clikt).
 
 ```groovy
 dependencies {
    implementation("com.github.ajalt:clikt:2.4.0")
 }
 ```
 
+For Kotlin/Native and Kotlin/JS, use `"com.github.ajalt:clikt-multiplatform:2.4.0"` instead.
+
+<details>
+   <summary>Snapshot builds are also available</summary>
+   
+You'll need to add the Sonatype snapshots repository: 
+      
+```kotlin
+repositories {
+    maven {
+        url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
+    }
+}
+```   
+  
+</details>
+
 ## License
 
     Copyright 2018-2020 AJ Alt

README.md

@@ -8,43 +8,27 @@ buildscript {
 
     dependencies {
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-        classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.10.0"
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.10.1"
     }
 }
 
-apply plugin: 'idea'
-apply plugin: 'org.jetbrains.dokka'
-
-repositories {
-    mavenCentral()
-    jcenter()
-}
-
-subprojects {
-    apply plugin: 'kotlin'
-
-    group = GROUP
-    version = VERSION_NAME
-
+allprojects {
+    group = "com.github.ajalt"
+    version = getPublishVersion()
     repositories {
         mavenCentral()
         jcenter()
     }
+}
 
-    dependencies {
-        compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+@SuppressWarnings("GrMethodMayBeStatic") // false-positive; we access VERSION_NAME
+private def getPublishVersion() {
+    final tag = System.getenv("BUILD_TAG")
+    if (tag != null) return tag
 
-        testImplementation 'junit:junit:4.12'
-        testImplementation 'io.kotlintest:kotlintest-assertions:3.4.2'
-        testImplementation 'com.github.stefanbirkner:system-rules:1.18.0'
-        testImplementation 'com.google.jimfs:jimfs:1.1'
-        testImplementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
-    }
-
-    compileKotlin {
-        kotlinOptions.jvmTarget = "1.8"
-    }
-    compileTestKotlin {
-        kotlinOptions.jvmTarget = "1.8"
+    final buildNumber = System.getenv("BUILD_NUMBER")
+    if (buildNumber != null) {
+        return VERSION_NAME + "." + buildNumber + "-SNAPSHOT"
     }
+    return VERSION_NAME
 }