README.en.md

Yandex Cloud Toolkit for the Intellij platform

The Yandex Cloud Toolkit plugin adds integration with Yandex Cloud to the family of IDEs on the IntelliJ platform from JetBrains.

Scope

• Resource Manager: Yandex Cloud resource management.
• Cloud Functions: Function management, loading versions, remote launch, viewing logs.
• API Gateways: API gateway management, viewing and updating specs.
• Service Accounts: Service account management, role assignment.

Supported IDEs

All IDEs on the IntelliJ 2020.1+ platform.

Installation

Method 1. Plugin repository

1. Add the https://github.com/yandex-cloud/ide-plugin-jetbrains/releases/download/latest/updatePlugins.xml plugin repository to the IDE.
2. Search for and install the Yandex Cloud Toolkit plugin.

Method 2. Installing from disk

1. Download or build the desired version of the Yandex Cloud Toolkit plugin.
2. Install the plugin to the IDE from disk.

Usage

1. Use OAuth or the Yandex Cloud CLI to log in to Yandex Cloud. To do this, open the Yandex Cloud window in the lower left-hand corner of the IDE and select or create a Yandex Cloud account.
2. Resources will appear in the Yandex Cloud window. Select the desired resource and action from the pop-up menu.

Creating a build

To build the plugin, run the following Gradle job: gradlew buildPlugin

Build output: ./build/libs/yandex-cloud-toolkit-${version}.jar

Additional Gradle jobs:

• buildRepository: Completes the plugin repository template.
• printVersion: Outputs the plugin version to use from GitHub Actions.

Development

Improvement

1. Add a new functionality.
2. Test the plugin by running the IDE via gradle runIde.
3. Update CHANGELOG.md for the Unreleased version in the right format.
4. Make a PR with the changes.

Release

1. Increase the pluginVersion in gradle.properties.
2. Replace Unreleased with the new version in CHANGELOG.md.
3. If required, update the plugin description in resources/pluginDescription.html and README.md.
4. Submit the changes to the origin/deploy branch.