Add publishing to plugin portal

ileasile · ileasile · commit f39e3c86bb61 · 2021-02-05T19:08:16.000+03:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -119,6 +119,14 @@ tasks.register("publishLocal") {
     )
 }
 
+tasks.register("publishToPluginPortal") {
+    group = "publishing"
+
+    dependsOn(
+        ":api-gradle-plugin:publishPlugins"
+    )
+}
+
 tasks.jar {
     manifest {
         attributes["Main-Class"] = taskOptions.mainClassFQN
diff --git a/docs/libraries.md b/docs/libraries.md
@@ -52,68 +52,27 @@ You may also add a Kotlin kernel integration to your library using a
 In the following code snippets `<jupyterApiVersion>` is one of the published versions from the link above.
 It is encouraged to use the latest stable version.
 
-First, adjust your `settings.gradle` file:
-```groovy
-pluginManagement {
-    repositories {
-        maven("https://kotlin.bintray.com/kotlin-datascience/")
-    }
-
-   resolutionStrategy {
-      eachPlugin {
-         if (requested.id.id == 'org.jetbrains.kotlinx.jupyter.api.plugin') {
-            useModule('org.jetbrains.kotlinx.jupyter:kotlin-jupyter-api-gradle-plugin:<jupyterApiVersion>')
-         }
-      }
-   }
-}
-```
-
-Or, **alternatively**, your `setting.gradle.kts` file:
-```kotlin
-pluginManagement {
-    repositories {
-        maven("https://kotlin.bintray.com/kotlin-datascience/")
-    }
-
-    resolutionStrategy {
-        eachPlugin {
-            when (requested.id.id) {
-                "org.jetbrains.kotlinx.jupyter.api.plugin" -> useModule("org.jetbrains.kotlinx.jupyter:kotlin-jupyter-api-gradle-plugin:<jupyterApiVersion>")
-            }
-        }
-    }
-}
-```
-
-Then, add the plugin and API dependencies into your buildscript.
+First, add the plugin dependency into your buildscript.
 
 For `build.gradle`:
 ```groovy
 plugins {
-    id "org.jetbrains.kotlinx.jupyter.api.plugin" version "<jupyterApiVersion>"
-}
-
-dependencies {
-    implementation "org.jetbrains.kotlin:kotlin-stdlib"
-    implementation "org.jetbrains.kotlin:kotlin-reflect"
-    compileOnly("org.jetbrains.kotlinx.jupyter:kotlin-jupyter-api:<jupyterApiVersion>")
+    id "org.jetbrains.kotlin.jupyter.api" version "<jupyterApiVersion>"
 }
 ```
 
 For `build.gradle.kts`:
 ```kotlin
 plugins {
-    id("org.jetbrains.kotlinx.jupyter.api.plugin") version "<jupyterApiVersion>"
-}
-
-dependencies { 
-    implementation(kotlin("stdlib"))
-    implementation(kotlin("reflect"))
-    compileOnly("org.jetbrains.kotlinx.jupyter:kotlin-jupyter-api:<jupyterApiVersion>")
+    kotlin("jupyter.api") version "<jupyterApiVersion>"
 }
 ```
 
+This plugin adds dependencies to api and annotations ("scanner") artifacts to your project. You may turn of
+the auto-including of these artifacts by specifying following Gradle properties: 
+ - `kotlin.jupyter.add.api` to `false`. Add it manually using `org.jetbrains.kotlinx.jupyter.api.plugin.UtilKt.addKotlinJupyterApiDependency`
+ - `kotlin.jupyter.add.scanner` to `false`. Add it manually using `org.jetbrains.kotlinx.jupyter.api.plugin.UtilKt.addKotlinJupyterScannerDependency`
+
 Finally, refer your implementations of `org.jetbrains.kotlinx.jupyter.api.libraries.LibraryDefinitionProducer` and/or
 `org.jetbrains.kotlinx.jupyter.api.libraries.LibraryDefinition` in your buildscript.
 
@@ -162,14 +121,6 @@ definitions inside your JAR - you may mark them with special annotations
 and attach specific annotation processor to process them. See how it
 works.
 
-Add these two additional dependencies to your buildscript:
-```groovy
-dependencies { 
-    implementation("org.jetbrains.kotlinx.jupyter:kotlin-jupyter-api-annotations:<jupyterApiVersion>")
-    kapt("org.jetbrains.kotlinx.jupyter:kotlin-jupyter-api-annotations:<jupyterApiVersion>")
-}
-```
-
 Now you don't need to specify options for `processJupyterApiResources` task.
 Just mark your integration class with `JupyterLibrary` annotations:
 
diff --git a/jupyter-lib/api-gradle-plugin/build.gradle.kts b/jupyter-lib/api-gradle-plugin/build.gradle.kts
@@ -1,13 +1,15 @@
 import org.jetbrains.kotlinx.jupyter.publishing.addPublication
 
 plugins {
+    id("com.gradle.plugin-publish") version "0.12.0"
     id("org.jlleitschuh.gradle.ktlint")
     `java-gradle-plugin`
     `kotlin-dsl`
     id("org.jetbrains.kotlinx.jupyter.publishing")
 }
 
 project.version = rootProject.version
+project.group = "org.jetbrains.kotlinx.jupyter"
 
 val junitVersion: String by rootProject
 
@@ -57,17 +59,38 @@ tasks.test {
     }
 }
 
+val pluginName = "apiGradlePlugin"
+
 gradlePlugin {
     plugins {
-        create("apiGradlePlugin") {
-            id = "org.jetbrains.kotlinx.jupyter.api.plugin"
+        create(pluginName) {
+            id = "org.jetbrains.kotlin.jupyter.api"
             implementationClass = "org.jetbrains.kotlinx.jupyter.api.plugin.ApiGradlePlugin"
         }
     }
 }
 
+pluginBundle {
+    // These settings are set for the whole plugin bundle
+    website = "https://github.com/Kotlin/kotlin-jupyter"
+    vcsUrl = "https://github.com/Kotlin/kotlin-jupyter"
+
+    (plugins) {
+        pluginName {
+            // id is captured from java-gradle-plugin configuration
+            displayName = "Kotlin Jupyter kernel integration plugin"
+            description = "Gradle plugin providing a smooth Jupyter notebooks integration for Kotlin libraries"
+            tags = listOf("jupyter", "kernel", "kotlin")
+        }
+    }
+
+    mavenCoordinates {
+        groupId = "org.jetbrains.kotlin"
+    }
+}
+
 addPublication {
-    publicationName = "apiGradlePlugin"
+    publicationName = pluginName
     artifactId = "kotlin-jupyter-api-gradle-plugin"
     bintrayDescription = "Gradle plugin providing a smooth Jupyter notebooks integration for Kotlin libraries"
     bintrayPackageName = artifactId
diff --git a/jupyter-lib/api-gradle-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/ApiGradlePlugin.kt b/jupyter-lib/api-gradle-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/ApiGradlePlugin.kt
@@ -3,6 +3,7 @@ package org.jetbrains.kotlinx.jupyter.api.plugin
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.invoke
+import org.gradle.kotlin.dsl.maven
 import org.gradle.kotlin.dsl.register
 import org.gradle.kotlin.dsl.repositories
 import org.jetbrains.kotlin.gradle.internal.Kapt3GradleSubplugin
@@ -23,8 +24,11 @@ class ApiGradlePlugin : Plugin<Project> {
 
         target.repositories {
             mavenCentral()
+            maven("https://kotlin.bintray.com/kotlin-datascience")
         }
 
+        target.addDependenciesIfNeeded()
+
         target.tasks {
             val resourcesTaskName = "processJupyterApiResources"
             register<JupyterApiResourcesTask>(resourcesTaskName) {
diff --git a/jupyter-lib/api-gradle-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/util.kt b/jupyter-lib/api-gradle-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/util.kt
@@ -0,0 +1,45 @@
+package org.jetbrains.kotlinx.jupyter.api.plugin
+
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.dependencies
+
+private const val GROUP_ID = "org.jetbrains.kotlinx.jupyter"
+
+private fun Project.getFlag(propertyName: String, default: Boolean = false): Boolean {
+    return findProperty(propertyName)?.let {
+        when (it) {
+            "true", true -> true
+            "false", false -> false
+            else -> null
+        }
+    } ?: default
+}
+
+fun kotlinJupyterApiVersion(): String {
+    return ApiGradlePlugin::class.java.classLoader.getResource("VERSION")!!.readText()
+}
+
+fun Project.addKotlinJupyterApiDependency(version: String? = null) {
+    val apiVersion = version ?: kotlinJupyterApiVersion()
+    dependencies {
+        "compileOnly"("$GROUP_ID:kotlin-jupyter-api:$apiVersion")
+    }
+}
+
+fun Project.addKotlinJupyterScannerDependency(version: String? = null) {
+    val apiVersion = version ?: kotlinJupyterApiVersion()
+    val mavenCoordinates = "$GROUP_ID:kotlin-jupyter-api-annotations:$apiVersion"
+    dependencies {
+        "implementation"(mavenCoordinates)
+        "kapt"(mavenCoordinates)
+    }
+}
+
+internal fun Project.addDependenciesIfNeeded() {
+    if (getFlag("kotlin.jupyter.add.api", true)) {
+        addKotlinJupyterApiDependency()
+    }
+    if (getFlag("kotlin.jupyter.add.scanner", true)) {
+        addKotlinJupyterScannerDependency()
+    }
+}
diff --git a/jupyter-lib/api-gradle-plugin/src/test/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/test/ResourcesTaskTests.kt b/jupyter-lib/api-gradle-plugin/src/test/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/test/ResourcesTaskTests.kt
@@ -38,7 +38,12 @@ class ResourcesTaskTests {
         return GradleRunner.create()
             .withProjectDir(projectDir)
             .withPluginClasspath()
-            .withArguments(RESOURCES_TASK_NAME)
+            .withArguments(
+                RESOURCES_TASK_NAME,
+                "-Pkotlin.jupyter.add.api=false",
+                "-Pkotlin.jupyter.add.scanner=false"
+            )
+            .forwardOutput()
             .build()
     }
 
@@ -133,13 +138,7 @@ class ResourcesTaskTests {
             })
             """.trimIndent()
         )
-
-        GradleRunner.create()
-            .withProjectDir(projectDir)
-            .withPluginClasspath()
-            .withArguments("processJupyterApiResources")
-            .forwardOutput()
-            .build()
+        runResourcesTask()
 
         assertLibrariesJsonContents(
             LibrariesScanResult(
@@ -158,7 +157,7 @@ class ResourcesTaskTests {
         private val PLUGINS_BLOCK = """
             plugins {
                 id 'org.jetbrains.kotlin.jvm' version '1.4.20'
-                id 'org.jetbrains.kotlinx.jupyter.api.plugin'
+                id 'org.jetbrains.kotlin.jupyter.api'
             }
         """.trimIndent()
     }
diff --git a/jupyter-lib/api-gradle-plugin/src/test/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/test/UtilTests.kt b/jupyter-lib/api-gradle-plugin/src/test/kotlin/org/jetbrains/kotlinx/jupyter/api/plugin/test/UtilTests.kt
@@ -0,0 +1,14 @@
+package org.jetbrains.kotlinx.jupyter.api.plugin.test
+
+import org.jetbrains.kotlinx.jupyter.api.plugin.kotlinJupyterApiVersion
+import org.junit.jupiter.api.Test
+import kotlin.test.assertTrue
+
+class UtilTests {
+
+    @Test
+    fun testVersion() {
+        val version = kotlinJupyterApiVersion().trim()
+        assertTrue(version.isNotEmpty())
+    }
+}
diff --git a/jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/Notebook.kt b/jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/Notebook.kt
@@ -6,6 +6,11 @@ import kotlin.jvm.Throws
  * [Notebook] is a main entry point for Kotlin Jupyter API
  */
 interface Notebook {
+    /**
+     * All executed cells of this notebook
+     */
+    val cellsList: Collection<CodeCell>
+
     /**
      * Mapping allowing to get cell by execution number
      */
diff --git a/kotlin-jupyter-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/build/distTasks.kt b/kotlin-jupyter-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/build/distTasks.kt
@@ -180,6 +180,7 @@ fun ProjectWithOptions.prepareAggregateUploadTasks() {
             tasksList.add(taskSpecGetter(taskSpec).taskName)
         }
 
+        tasksList.add("publishToPluginPortal")
         tasksList.add("bintrayUpload")
         tasksList.add("publishDocs")
 
diff --git a/kotlin-jupyter-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/build/util.kt b/kotlin-jupyter-plugin/src/main/kotlin/org/jetbrains/kotlinx/jupyter/build/util.kt
@@ -51,8 +51,8 @@ fun <T> Project.getOrInitProperty(name: String, initializer: () -> T): T {
 fun Project.getFlag(propertyName: String, default: Boolean = false): Boolean {
     return rootProject.findProperty(propertyName)?.let {
         when (it) {
-            "true" -> true
-            "false" -> false
+            "true", true -> true
+            "false", false -> false
             else -> null
         }
     } ?: default
diff --git a/src/main/kotlin/org/jetbrains/kotlinx/jupyter/apiImpl.kt b/src/main/kotlin/org/jetbrains/kotlinx/jupyter/apiImpl.kt
@@ -99,6 +99,9 @@ class NotebookImpl(
 ) : Notebook {
     private val cells = hashMapOf<Int, CodeCellImpl>()
 
+    override val cellsList: Collection<CodeCellImpl>
+        get() = cells.values
+
     override fun getCell(id: Int): CodeCellImpl {
         return cells[id] ?: throw ArrayIndexOutOfBoundsException(
             "There is no cell with number '$id'"
diff --git a/src/test/kotlin/org/jetbrains/kotlinx/jupyter/test/testUtil.kt b/src/test/kotlin/org/jetbrains/kotlinx/jupyter/test/testUtil.kt
@@ -128,6 +128,9 @@ class TestDisplayHandler(val list: MutableList<Any> = mutableListOf()) : Display
 class NotebookMock : Notebook {
     private val cells = hashMapOf<Int, CodeCellImpl>()
 
+    override val cellsList: Collection<CodeCell>
+        get() = emptyList()
+
     override fun getCell(id: Int): CodeCellImpl {
         return cells[id] ?: throw ArrayIndexOutOfBoundsException(
             "There is no cell with number '$id'"

Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,14 @@ tasks.register("publishLocal") {`
`119`	`119`	`)`
`120`	`120`	`}`
`121`	`121`
	`122`	`+tasks.register("publishToPluginPortal") {`
	`123`	`+ group = "publishing"`
	`124`	`+`
	`125`	`+ dependsOn(`
	`126`	`+ ":api-gradle-plugin:publishPlugins"`
	`127`	`+ )`
	`128`	`+}`
	`129`	`+`
`122`	`130`	`tasks.jar {`
`123`	`131`	`manifest {`
`124`	`132`	`attributes["Main-Class"] = taskOptions.mainClassFQN`
Original file line number	Diff line number	Diff line change
`@@ -180,6 +180,7 @@ fun ProjectWithOptions.prepareAggregateUploadTasks() {`
`180`	`180`	`tasksList.add(taskSpecGetter(taskSpec).taskName)`
`181`	`181`	`}`
`182`	`182`
	`183`	`+ tasksList.add("publishToPluginPortal")`
`183`	`184`	`tasksList.add("bintrayUpload")`
`184`	`185`	`tasksList.add("publishDocs")`
`185`	`186`