hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

publishing_plugin.md: cleanup/fixes

Browse Source
This commit is contained in:
Yann Cébron 2024-10-02 15:03:46 +02:00
parent 4170763f25
commit 3fea8195e9
1 changed files with 60 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
topics/basics/getting_started/publishing_plugin.md
View File

@ -95,25 +95,10 @@ This section describes two options to supply the _Personal Access Token_ via Gra
Start by defining an environment variable such as:
<tabs group="gradlePluginVersion">
<tab title="IntelliJ Platform Gradle Plugin (2.x)" group-key="2.x">
```bash
export ORG_GRADLE_PROJECT_intellijPlatform.publishing.token='YOUR_TOKEN'
export ORG_GRADLE_PROJECT_intellijPlatformPublishingToken='YOUR_TOKEN'
```
</tab>
<tab title="Gradle IntelliJ Plugin (1.x)" group-key="1.x">
```bash
export ORG_GRADLE_PROJECT_intellijPublishToken='YOUR_TOKEN'
```
</tab>
</tabs>
> On macOS systems, environment variables set in <path>.bash_profile</path> are only visible to processes run from bash.
> Environment variables visible to all processes need to be defined in [Environment.plist](https://developer.apple.com/library/archive/qa/qa1067/_index.html).
>
@ -124,48 +109,27 @@ Now provide the environment variable in the run configuration for running the `p
To do so, create a Gradle run configuration (if not already done), select the Gradle project, specify the
`publishPlugin` task, and then add the environment variable.
##### IntelliJ Platform Gradle Plugin (2.x)
<tabs group="gradlePluginVersion">
<tabs group="languages">
<tab title="Kotlin" group-key="kotlin">
<tab title="IntelliJ Platform Gradle Plugin (2.x)" group-key="2.x">
```kotlin
publishPlugin {
token.set(System.getenv("ORG_GRADLE_PROJECT_intellijPlatform.publishing.token"))
intellijPlatform {
publishing {
token = providers.gradleProperty("intellijPlatformPublishingToken")
}
}
```
</tab>
<tab title="Groovy" group-key="groovy">
```groovy
publishPlugin {
token = System.getenv("ORG_GRADLE_PROJECT_intellijPlatform.publishing.token")
}
```
</tab>
</tabs>
##### Gradle IntelliJ Plugin (1.x)
{collapsible="true" default-state="collapsed"}
<tabs group="languages">
<tab title="Kotlin" group-key="kotlin">
<tab title="Gradle IntelliJ Plugin (1.x)" group-key="1.x">
```kotlin
publishPlugin {
token.set(System.getenv("ORG_GRADLE_PROJECT_intellijPublishToken"))
}
```
</tab>
<tab title="Groovy" group-key="groovy">
```groovy
publishPlugin {
token = System.getenv("ORG_GRADLE_PROJECT_intellijPublishToken")
tasks {
publishPlugin {
token = providers.gradleProperty("intellijPlatformPublishingToken")
}
}
```
@ -179,25 +143,10 @@ Note that it's still required to put some default values (can be empty) in the G
Like using environment variables, the token can also be passed as a parameter to the Gradle task.
For example, provide the parameter on the command line or by putting it in the arguments of the Gradle run configuration.
<tabs group="gradlePluginVersion">
<tab title="IntelliJ Platform Gradle Plugin (2.x)" group-key="2.x">
```bash
-Dorg.gradle.project.intellijPlatform.publishing.token=YOUR_TOKEN
-PintellijPlatformPublishingToken=YOUR_TOKEN
```
</tab>
<tab title="Gradle IntelliJ Plugin (1.x)" group-key="1.x">
```bash
-Dorg.gradle.project.intellijPublishToken=YOUR_TOKEN
```
</tab>
</tabs>
Note that in this case also, it's still required to put some default values (can be empty) in the Gradle properties
### Deploying a Plugin with Gradle
@ -226,15 +175,21 @@ If successfully deployed, any users who currently have this plugin installed on
### Specifying a Release Channel
It's possible to deploy plugins to a chosen release channel by configuring the `publishPlugin.channels` property
(Reference: [2.x](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-channels), [1.x](tools_gradle_intellij_plugin.md#tasks-publishplugin-channels)).
<tabs group="gradlePluginVersion">
<tab title="IntelliJ Platform Gradle Plugin (2.x)" group-key="2.x">
It's possible to deploy plugins to a chosen release channel by configuring the [`intellijPlatform.publishing.channels`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-channels) extension property.
<tabs group="languages">
<tab title="Kotlin" group-key="kotlin">
```kotlin
publishPlugin {
channels.set(listOf("beta"))
intellijPlatform {
publishing {
channels = listOf("beta")
}
}
```
@ -242,14 +197,49 @@ publishPlugin {
<tab title="Groovy" group-key="groovy">
```groovy
publishPlugin {
intellijPlatform {
publishing {
channels = ['beta']
}
}
```
</tab>
</tabs>
</tab>
<tab title="Gradle IntelliJ Plugin (1.x)" group-key="1.x">
It's possible to deploy plugins to a chosen release channel by configuring the [`publishPlugin.channels`](tools_gradle_intellij_plugin.md#tasks-publishplugin-channels) task property.
<tabs group="languages">
<tab title="Kotlin" group-key="kotlin">
```kotlin
tasks {
publishPlugin {
channels = listOf("beta")
}
}
```
</tab>
<tab title="Groovy" group-key="groovy">
```groovy
tasks {
publishPlugin {
channels = ['beta']
}
}
```
</tab>
</tabs>
</tab>
</tabs>
When empty, this uses the default plugin repository, available to all [JetBrains Marketplace](https://plugins.jetbrains.com/) users.
However, it's possible to publish it to an arbitrarily named channel.
These non-default release channels are treated as separate repositories.