IntelliJ Platform Gradle Plugin: IntelliJPlatform.Publishing extension, PublishPluginTask

This commit is contained in:
Jakub Chrzanowski 2024-01-31 22:04:49 +01:00
parent 305c64fc9b
commit 60b942121e
No known key found for this signature in database
GPG Key ID: C39095BFD769862E
2 changed files with 133 additions and 4 deletions

View File

@ -482,6 +482,9 @@ The hostname used for publishing the plugin.
Type
: `Property<String>`
Default value
: `"https://plugins.jetbrains.com"`
See also:
- [Tasks: `publishPlugin.host`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-host)
@ -489,10 +492,15 @@ See also:
### token
{#intellijPlatform-publishing-token}
Authorization token.
{style="narrow"}
Type
: `Property<String>`
Required
: yes
See also:
- [Tasks: `publishPlugin.token`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-token)
@ -500,21 +508,31 @@ See also:
### channel
{#intellijPlatform-publishing-channel}
A channel name to upload plugin to.
{style="narrow"}
Type
: `Property<String>`
Default value:
: `"default"`
See also:
- [Tasks: `publishPlugin.channels`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-channels)
-
- [Tasks: `publishPlugin.channel`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-channel)
### toolboxEnterprise
{#intellijPlatform-publishing-toolboxEnterprise}
Specifies if the Toolbox Enterprise plugin repository service should be used.
{style="narrow"}
Type
: `Property<String>`
Default value
: `false`
See also:
- [Tasks: `publishPlugin.toolboxEnterprise`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-toolboxEnterprise)
@ -522,12 +540,18 @@ See also:
### hidden
{#intellijPlatform-publishing-hidden}
Publish the plugin update and mark it as hidden to prevent public release after approval.
{style="narrow"}
Type
: `Property<String>`
Default value
: `false`
See also:
- [Tasks: `publishPlugin.hidden`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-hidden)
- [Hidden release](https://plugins.jetbrains.com/docs/marketplace/hidden-plugin.html)
## Signing

View File

@ -19,6 +19,10 @@ See also:
## classpathIndexCleanup
{#classpathIndexCleanup}
> Deprecated?
>
{style="warning"}
## initializeIntelliJPlatformPlugin
{#initializeIntelliJPlatformPlugin}
@ -38,6 +42,10 @@ See also:
## instrumentedJar
{#instrumentedJar}
> Not implemented.
>
{style="warning"}
## jarSearchableOptions
{#jarSearchableOptions}
@ -380,36 +388,125 @@ See also:
## publishPlugin
{#publishPlugin}
The task for publishing plugin to the remote plugins repository, such as [JetBrains Marketplace](https://plugins.jetbrains.com).
See also:
- [Uploading a Plugin to JetBrains Marketplace](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html#uploading-a-plugin-to-jetbrains-marketplace)
- [Plugin upload API](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html)
- [Publishing Plugin With Gradle](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html#publishing-plugin-with-gradle)
### archiveFile
{#publishPlugin-archiveFile}
ZIP archive to be published to the remote repository.
By default, it uses an output `archiveFile` of the [`signPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin) task if plugin signing is configured, otherwise [`buildPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#buildPlugin).
{style="narrow"}
Type
: `Property<RegularFileProperty>`
Default value
: [`signPlugin.archiveFile`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-archiveFile) or [`buildPlugin.archiveFile`](tools_intellij_platform_gradle_plugin_tasks.md#buildPlugin-archiveFile)
See also:
- [Extension: `intellijPlatform.signing`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing)
- [Tasks: `signPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin)
- [Tasks: `buildPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#buildPlugin)
### host
{#publishPlugin-host}
URL host of a plugin repository.
{style="narrow"}
Type
: `Property<String>`
Default value
: [`intellijPlatform.publishing.host`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-host)
See also:
- [Extension `intellijPlatform.publishing.host`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-host)
### token
{#publishPlugin-token}
Authorization token.
### channels
{#publishPlugin-channels}
{style="narrow"}
Type
: `Property<String>`
Required
: yes
Default value
: [`intellijPlatform.publishing.token`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-token)
See also:
- [Extension: `intellijPlatform.publishing.token`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-token)
### channel
{#publishPlugin-channel}
A channel name to upload plugin to.
{style="narrow"}
Type
: `Property<String>`
Default value:
: [`intellijPlatform.publishing.channel`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-channel)
See also:
- [Extension: `intellijPlatform.publishing.channel`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-channel)
### hidden
{#publishPlugin-hidden}
Publish the plugin update and mark it as hidden to prevent public release after approval.
{style="narrow"}
Type
: `Property<String>`
Default value
: [`intellijPlatform.publishing.hidden`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-hidden)
See also:
- [Extension: `intellijPlatform.publishing.hidden`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-hidden)
- [Hidden release](https://plugins.jetbrains.com/docs/marketplace/hidden-plugin.html)
### toolboxEnterprise
{#publishPlugin-toolboxEnterprise}
Specifies if the Toolbox Enterprise plugin repository service should be used.
{style="narrow"}
Type
: `Property<String>`
Default value
: [`intellijPlatform.publishing.toolboxEnterprise`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-toolboxEnterprise)
See also:
- [Extension: `intellijPlatform.publishing.toolboxEnterprise`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-toolboxEnterprise)
## runIdePerformanceTest
{#runIdePerformanceTest}
> Not implemented.
>
{style="warning"}
## runIde
{#runIde}
@ -418,6 +515,10 @@ See also:
## setupDependencies
{#setupDependencies}
> Deprecated.
>
{style="warning"}
## signPlugin
{#signPlugin}
@ -430,6 +531,10 @@ See also:
## testIdeUi
{#testIdeUi}
> Not implemented.
>
{style="warning"}
## verifyPluginProjectConfiguration
{#verifyPluginProjectConfiguration}