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

align "JetBrains Plugins Repository" name

Browse Source
This commit is contained in:
Yann Cébron 2020-05-14 15:38:32 +02:00
parent 00d940a370
commit 202bfceea8
12 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
basics/getting_started/plugin_compatibility.md
View File

@ -140,7 +140,7 @@ For [Gradle-based](/tutorials/build_system.md) projects, [Plugin Verifier](/refe
For [DevKit-based](/basics/getting_started/using_dev_kit.md) projects, create an SDK pointing to an installation of the intended target IntelliJ Platform-based product, e.g., PhpStorm, rather than IntelliJ IDEA.
Use the same development version of the IntelliJ platform as the targeted product.
Based on the tables above, the [JetBrains plugin repository](https://plugins.jetbrains.com/) automatically detects the JetBrains products with which a plugin is compatible, and makes the compatibility information available to plugin authors.
Based on the tables above, the [JetBrains Plugins Repository](https://plugins.jetbrains.com/) automatically detects the JetBrains products with which a plugin is compatible, and makes the compatibility information available to plugin authors.
The compatibility information determines if plugins are available at the plugin repository to users of a particular JetBrains product.
## Platform API Version Compatibility

12
basics/getting_started/publishing_plugin.md
View File

@ -4,11 +4,11 @@ title: Publishing a Plugin
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
When your plugin is ready you can publish it to a plugin repository so that other users can install it.
You can choose to publish it on the [JetBrains Plugin Repository](https://plugins.jetbrains.com)
You can choose to publish it on the [JetBrains Plugins Repository](https://plugins.jetbrains.com)
or a custom plugin repository.
### Publishing to the JetBrains Plugin Repository
To upload your plugin to the [JetBrains Plugin Repository](https://plugins.jetbrains.com),
### Publishing to the JetBrains Plugins Repository
To upload your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com),
you must login with your personal JetBrains Account.
**To get your JetBrains account**
@ -16,12 +16,12 @@ you must login with your personal JetBrains Account.
1. Open the [JetBrains Account Center](https://account.jetbrains.com) and click **Create Account**.
2. Fill in all fields in the **Create JetBrains Account** form that opens and click **Register**.
**To upload your plugin to JetBrains Plugin Repository**
**To upload your plugin to JetBrains Plugins Repository**
1. [Login to JetBrains Plugin Repository](https://plugins.jetbrains.com/author/me) with your personal JetBrains account.
1. [Login to JetBrains Plugins Repository](https://plugins.jetbrains.com/author/me) with your personal JetBrains account.
2. On your Profile page that opens, click **Add new plugin**.
3. Fill in the **Add new plugin** form that opens and click the **Add the plugin** button to upload your plugin.
### Publishing a Plugin to an Custom Plugin Repository
If you plan to publish your plugin to a repository _other than_ the [JetBrains Plugin Repository](https://plugins.jetbrains.com),
If you plan to publish your plugin to a repository _other than_ the [JetBrains Plugins Repository](https://plugins.jetbrains.com),
please refer to the [Publishing to Custom Plugin Repositories](update_plugins_format.md) documentation.

2
basics/getting_started/update_plugins_format.md
View File

@ -3,7 +3,7 @@ title: Publishing a Plugin to a Custom Plugin Repository
---
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
If you intend to use a plugin repository _other than_ the [JetBrains Plugin Repository](https://plugins.jetbrains.com),
If you intend to use a plugin repository _other than_ the [JetBrains Plugins Repository](https://plugins.jetbrains.com),
you will need to:
* Create and maintain an `updatePlugins.xml` file on the HTTPS web server you are using for your custom repository.
This file describes all the plugins available in your custom repository and each plugin's download URL.

2
basics/plugin_structure/dynamic_plugins.md
View File

@ -10,7 +10,7 @@ Starting with 2020.1 release, the ability to install, update and uninstall plugi
For a plugin to support this, all restrictions listed below must be met. To verify a plugin locally, run _Plugin DevKit | Plugin descriptor | Plugin.xml dynamic plugin verification_
inspection on all plugin descriptor files (required `plugin.xml` as well as any additional files).
For plugins hosted on the [JetBrains plugin repository](https://plugins.jetbrains.com) the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/)
For plugins hosted on the [JetBrains Plugins Repository](https://plugins.jetbrains.com) the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/)
will run these checks automatically. See [Plugin Verifier](/reference_guide/api_changes_list.md#plugin-verifier) for more information on how to run it locally.
During development, [Enabling Auto-Reload](/basics/ide_development_instance.md#enabling-auto-reload) will allow code changes to take effect immediately in the sandbox IDE instance.

2
basics/types_of_plugins.md
View File

@ -3,7 +3,7 @@ title: Main Types of Plugins
---
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
Products based on the *IntelliJ Platform* can be modified and adjusted for custom purposes by adding plugins. All downloadable plugins are available at the [JetBrains Plugin Repository](https://plugins.jetbrains.com/).
Products based on the *IntelliJ Platform* can be modified and adjusted for custom purposes by adding plugins. All downloadable plugins are available at the [JetBrains Plugins Repository](https://plugins.jetbrains.com/).
The most common types of plugins include:

2
intro/sdk_code_guidelines.md
View File

@ -166,7 +166,7 @@ The sequence of elements in an SDK code sample `plugin.xml` file is:
* `<vendor>` Set the value to `IntelliJ Platform SDK`.
Set the attributes:
* `email` omit this attribute.
* `url` to the JetBrains plugin repository `"https://plugins.jetbrains.com"`
* `url` to the JetBrains Plugins Repository `"https://plugins.jetbrains.com"`
* The remainder of the [plugin configuration elements](/basics/plugin_structure/plugin_configuration_file.md) should only appear if they are needed by a specific plugin.
## Testing

4
reference_guide/api_changes_list.md
View File

@ -65,14 +65,14 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
IntelliJ API may be occasionally changed between releases, leading to incompatibilities of existing plugins with newer IDE builds.
<!--
> **NOTE** Starting with 2020.1 release, IntelliJ Platform–based IDEs will use compatibility check information provided by the [JetBrains plugin repository](https://plugins.jetbrains.com) to highlight possible compatibility issues to users directly in the IDE's "Plugins" manager.
> **NOTE** Starting with 2020.1 release, IntelliJ Platform–based IDEs will use compatibility check information provided by the [JetBrains Plugins Repository](https://plugins.jetbrains.com) to highlight possible compatibility issues to users directly in the IDE's "Plugins" manager.
Therefore, it is important to keep your plugins up to date with regard to the existing and upcoming API changes.
-->
## Verifying Compatibility
### Plugin Verifier
Compatibility with newer IDEs can easily be verified for plugins hosted on the [JetBrains plugin repository](https://plugins.jetbrains.com) using the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/).
Compatibility with newer IDEs can easily be verified for plugins hosted on the [JetBrains Plugins Repository](https://plugins.jetbrains.com) using the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/).
For local verification or non-public plugins, [intellij-plugin-verifier](https://github.com/JetBrains/intellij-plugin-verifier) can be used standalone as well.
Integration in [Gradle build](/tutorials/build_system.md) is currently possible via some additional scripts, please see [this issue](https://github.com/JetBrains/gradle-intellij-plugin/issues/385) for details.

4
reference_guide/api_notable/api_notable_list_2019.md
View File

@ -29,7 +29,7 @@ User-customizable date/time formatting
Unbundled plugins
: Several plugins (Heroku integration, RubyMotion support, Java Applets Support) for no longer actively maintained technology have been moved to a [separate repository](https://github.com/JetBrains/intellij-obsolete-plugins/).
If your plugin depends on them, users will need to install them from the [JetBrains plugin repository](https://plugins.jetbrains.com).
If your plugin depends on them, users will need to install them from the [JetBrains Plugins Repository](https://plugins.jetbrains.com).
# 2019.2
@ -82,7 +82,7 @@ Java functionality extracted as plugin
: If your plugin depends on Java, it must be specified now, please see [blog post](https://blog.jetbrains.com/platform/2019/06/java-functionality-extracted-as-a-plugin/) for details.
Unbundled plugins
: Several plugins (J2ME, JsTestDriver, Struts 1.x) for no longer actively maintained technology have been moved to a [separate repository](https://github.com/JetBrains/intellij-obsolete-plugins/). If your plugin depends on them, users will need to install them from the [JetBrains plugin repository](https://plugins.jetbrains.com).
: Several plugins (J2ME, JsTestDriver, Struts 1.x) for no longer actively maintained technology have been moved to a [separate repository](https://github.com/JetBrains/intellij-obsolete-plugins/). If your plugin depends on them, users will need to install them from the [JetBrains Plugins Repository](https://plugins.jetbrains.com).

2
reference_guide/api_notable/api_notable_list_2020.md
View File

@ -46,4 +46,4 @@ EOL for JetBrains TFS Plugin
Unbundled plugins
: Several plugins (Cloud Foundry, Google App Engine) for no longer actively maintained technology have been unbundled.
If your plugin depends on them, users will need to install them from the [JetBrains plugin repository](https://plugins.jetbrains.com).
If your plugin depends on them, users will need to install them from the [JetBrains Plugins Repository](https://plugins.jetbrains.com).

2
reference_guide/ui_themes/themes_customize.md
View File

@ -28,7 +28,7 @@ Colors are defined by six-digit RGB or eight-digit RGBA hexadecimal notation.
### UI Theme Reference Implementations
When learning new syntax, it is often useful to have some existing implementations for reference.
For example, refer to the [Theme description file](upsource:///platform/platform-resources/src/themes/HighContrast.theme.json) for the IntelliJ IDEA _High Contrast_ Theme.
It may also be helpful to review some of the [UI Themes available](https://plugins.jetbrains.com/search?headline=164-theme&tags=Theme) at the JetBrains Plugin Repository.
It may also be helpful to review some of the [UI Themes available](https://plugins.jetbrains.com/search?headline=164-theme&tags=Theme) at the JetBrains Plugins Repository.
## Defining Named Colors
Colors can always be defined individually as six-digit RGB or eight-digit RGBA hexadecimal notation.

2
tutorials/build_system.md
View File

@ -8,7 +8,7 @@ The plugin takes care of the dependencies of your plugin project - both the base
> **NOTE** If a new plugin will be Scala-based, a dedicated SBT plugin [sbt-idea-plugin](https://github.com/JetBrains/sbt-idea-plugin) is available.
The gradle-intellij-plugin provides tasks to run the IDE with your plugin and to publish your plugin to the [JetBrains plugins repository](https://plugins.jetbrains.com).
The gradle-intellij-plugin provides tasks to run the IDE with your plugin and to publish your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com).
To make sure that your plugin is not affected by [API changes](/reference_guide/api_changes_list.md) which may happen between major releases of the platform, you can easily build your plugin against many versions of the base IDE.
> **WARNING** When adding additional repositories to your Gradle build script, make sure to always use HTTPS protocol.

12
tutorials/build_system/deployment.md
View File

@ -3,7 +3,7 @@ title: Publishing Plugins with Gradle
---
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
Once you have configured Gradle support, you can automatically build and deploy your plugin to the [JetBrains Plugin Repository](https://plugins.jetbrains.com).
Once you have configured Gradle support, you can automatically build and deploy your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com).
To automatically deploy a plugin, you need to have _already published the plugin to the plugin repository at least once._
Please see the guide page for manually [publishing a plugin](../../basics/getting_started/publishing_plugin.md) for the first time.
@ -17,7 +17,7 @@ For manual distribution or local installation, invoke `gradle buildPlugin` targe
The resulting JAR/ZIP is located in `build/distributions` and can then be [installed](https://www.jetbrains.com/help/idea/managing-plugins.html#installing-plugins-from-disk) manually.
## Providing Your Hub Permanent Token to Gradle
To deploy a plugin to the plugin repository, you need to supply your [JetBrains Hub Permanent Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html).
To deploy a plugin to the JetBrains Plugins Repository, you need to supply your [JetBrains Hub Permanent Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html).
This page describes three options to supply your _Hub Permanent Token_ via Gradle using:
* Gradle properties,
* Environment variables,
@ -85,14 +85,14 @@ The first step when deploying a plugin is to confirm that it works correctly.
You may wish to verify this by [installing your plugin from disk](https://www.jetbrains.com/help/idea/managing-plugins.html) on a fresh instance of your target IDE(s).
### Publishing a Plugin
Once you are confident the plugin works as intended, make sure the plugin version is updated, as the JetBrains Plugin repository won't accept multiple artifacts with the same version.
To deploy a new version of your plugin to the JetBrains plugin repository, execute the following Gradle command:
Once you are confident the plugin works as intended, make sure the plugin version is updated, as the JetBrains Plugins Repository won't accept multiple artifacts with the same version.
To deploy a new version of your plugin to the JetBrains Plugins Repository, execute the following Gradle command:
```bash
gradle publishPlugin
```
Now check the most recent version of your plugin appears on the [Plugin Repository](https://plugins.jetbrains.com/).
Now check the most recent version of your plugin appears on the [JetBrains Plugins Repository](https://plugins.jetbrains.com/).
If successfully deployed, any users who currently have your plugin installed on an eligible version of the IntelliJ Platform are notified of a new update available on the following restart.
### Specifying a Release Channel
@ -105,7 +105,7 @@ publishPlugin {
}
```
When empty, this uses the default plugin repository, available to all [JetBrains plugin repository](https://plugins.jetbrains.com/) users.
When empty, this uses the default plugin repository, available to all [JetBrains Plugins Repository](https://plugins.jetbrains.com/) users.
However, you can publish to an arbitrarily-named channel.
These non-default release channels are treated as separate repositories.
When using a non-default release channel, users need to add a new [custom plugin repository](https://www.jetbrains.com/help/idea/managing-plugins.html#repos) to install your plugin.