Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notes about localBuild and plugins #1576

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
29 changes: 28 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,39 @@ Read the [IntelliJ Platform Gradle Plugin Integration Tests](INTEGRATION_TESTS.m

## Link With Your Project
It is possible to link your plugin project with the IntelliJ Platform Gradle Plugin project, so it'll be loaded and built as a module.
To integrate it with another consumer-like project, add the following line in the Gradle settings file and refresh your Gradle configuration:

To integrate it with another consumer-like project, you can add it as a local build:

1. Add the following line in the Gradle settings file, `settings.gradle.kts`, pointing to the local repository:

```kotlin
includeBuild("/path/to/gradle-intellij-plugin")
```

2. To ensure you're not pulling in the changes from the remote repository, comment the lines from `gradle/libs.versions.toml`

```toml
[versions]
...
# intelliJPlatform = "2.0.0-SNAPSHOT"
...
[plugins]
...
# intelliJPlatform = { id = "org.jetbrains.intellij.platform", version.ref = "intelliJPlatform" }
```

3. In `build.gradle.kts`, replace the plugin dependency with the local one:

```kotlin
// alias(libs.plugins.gradleIntelliJPlugin) // Gradle IntelliJ Plugin
id("org.jetbrains.intellij")
```
4. Clean and build the project:

```shell
./gradlew clean buildPlugin
```

## Pull Requests
To correctly prepare the pull requests, make sure to provide the following information:
- proper title and description of the GitHub Pull Request – describe what your change introduces, what issue it fixes, etc.
Expand Down