Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
295 changes: 266 additions & 29 deletions README.md

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions build-logic/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ repositories {
dependencies {
implementation(libs.plugin.structure)
implementation(libs.jackson.kotlin)
implementation(libs.marketplace.client)
}

gradlePlugin {
Expand All @@ -32,6 +33,12 @@ gradlePlugin {
displayName = "Install Toolbox Plugin"
description = "Installs the plugin into the local Toolbox directory"
}
create("toolboxPublish") {
id = "com.jetbrains.toolbox.publish"
implementationClass = "com.jetbrains.toolbox.buildlogic.PublishToolboxPlugin"
displayName = "Publish Toolbox Plugin"
description = "Packages and publishes a JetBrains Toolbox plugin to the JetBrains Marketplace"
}
}
}

Expand Down
105 changes: 105 additions & 0 deletions build-logic/src/main/kotlin/toolbox/buildlogic/PublishToolboxPlugin.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
package com.jetbrains.toolbox.buildlogic

import org.gradle.api.DefaultTask
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.TaskAction
import org.gradle.api.tasks.bundling.Zip
import org.gradle.work.DisableCachingByDefault
import org.jetbrains.intellij.pluginRepository.PluginRepositoryFactory
import org.jetbrains.intellij.pluginRepository.model.LicenseUrl
import org.jetbrains.intellij.pluginRepository.model.ProductFamily

/**
* Gradle plugin that packages and publishes a JetBrains Toolbox plugin to the
* [JetBrains Marketplace](https://plugins.jetbrains.com).
*/
class PublishToolboxPlugin : Plugin<Project> {
override fun apply(target: Project) {
val packageTask = target.tasks.register("packagePlugin", Zip::class.java) {
dependsOn(target.tasks.named("assemble"))
from(target.layout.buildDirectory.file("generated/extension.json"))
from(target.file("src/main/resources")) {
include("dependencies.json")
include("icon.svg")
into("${target.group}")
}
from(target.tasks.named("jar")) {
into("${target.group}/lib")
}
}

target.tasks.register("publishPlugin", PublishTask::class.java) {
dependsOn(packageTask)
extensionId.set(target.group.toString())
pluginZipFile.set(packageTask.flatMap { it.archiveFile })
vendor.set(target.extensions.extraProperties["vendor"].toString())
}
}

/**
* Task that uploads the packaged plugin ZIP to the JetBrains Marketplace.
*
* Requires the `JETBRAINS_MARKETPLACE_PUBLISH_TOKEN` environment variable to be set.
* The token can be generated from your JetBrains Marketplace account.
*/
@DisableCachingByDefault(because = "Publishes plugin to JetBrains Marketplace")
abstract class PublishTask : DefaultTask() {
@get:Input
abstract val extensionId: Property<String>

/** Path to the plugin ZIP archive produced by the `packagePlugin` task. */
@get:InputFile
abstract val pluginZipFile: RegularFileProperty

@get:Input
abstract val vendor: Property<String>

@TaskAction
fun publish() {
val jbMarketplaceToken: String? = System.getenv("JETBRAINS_MARKETPLACE_PUBLISH_TOKEN")
if (jbMarketplaceToken.isNullOrBlank()) {
error(
"Environment variable `JETBRAINS_MARKETPLACE_PUBLISH_TOKEN` is not set. " + "Please obtain a token from https://plugins.jetbrains.com and set it."
)
}

println("Publishing plugin ${extensionId.get()} to JetBrains Marketplace...")
println("Token prefix: ${jbMarketplaceToken.take(5)}*****")

val instance = PluginRepositoryFactory.create(
"https://plugins.jetbrains.com", jbMarketplaceToken
)

val existingPlugin = instance.pluginManager.getPluginByXmlId(
extensionId.get(), ProductFamily.TOOLBOX
)

if (existingPlugin != null) {
instance.uploader.uploadUpdateByXmlIdAndFamily(
extensionId.get(),
ProductFamily.TOOLBOX,
pluginZipFile.get().asFile,
null, // channel – not yet supported for Toolbox plugins.
"Bug fixes and improvements", // please make sure to update version notes here.
false
)
} else {
println("Plugin not found on Marketplace. Uploading as new plugin...")
instance.uploader.uploadNewPlugin(
pluginZipFile.get().asFile, // do not change
listOf("toolbox", "gateway"), // do not change
LicenseUrl.APACHE_2_0, // choose wisely
ProductFamily.TOOLBOX, // do not change
vendor = vendor.get(), // do not change
isHidden = true,
)
}
println("Plugin published successfully!")
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ class ToolboxGenerateJsonExtension : Plugin<Project> {
val gen = target.tasks.register("generateExtensionJson", GenerateExtensionJsonTask::class.java) {
extensionId.set(target.group.toString())
extensionVersion.set(target.version.toString())
metaName.set("Toolbox Sample Plugin")
metaName.set("Toolbox Sample Plugin Template")
metaDescription.set("Sample Plugin for JetBrains Toolbox")
metaVendor.set("JetBrains")
metaVendor.set(target.extensions.extraProperties["vendor"].toString())
metaUrl.set("https://www.jetbrains.com/toolbox/")
destinationFile.set(extensionJsonFile)
}
Expand Down
2 changes: 2 additions & 0 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
coroutines = "1.10.1"
jackson = "2.18.2"
kotlin = "2.1.0"
marketplace-client = "2.0.50"
toolbox-plugin-api = "1.8.65679"
plugin-structure = "3.320"

[libraries]
coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
jackson-kotlin = { module = "com.fasterxml.jackson.module:jackson-module-kotlin", version.ref = "jackson" }
marketplace-client = { module = "org.jetbrains.intellij:plugin-repository-rest-client", version.ref = "marketplace-client" }
toolbox-core-api = { module = "com.jetbrains.toolbox:core-api", version.ref = "toolbox-plugin-api" }
toolbox-remote-dev-api = { module = "com.jetbrains.toolbox:remote-dev-api", version.ref = "toolbox-plugin-api" }
toolbox-ui-api = { module = "com.jetbrains.toolbox:ui-api", version.ref = "toolbox-plugin-api" }
Expand Down
Binary file modified gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.0-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
Expand Down
104 changes: 6 additions & 98 deletions gradlew

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading