-
Notifications
You must be signed in to change notification settings - Fork 73
feat(jetbrains): Adds a JetBrains Toolbox integration module #180
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
Merged
Changes from 17 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
09873f9
wip
matifali d418701
Enhance JetBrains module config and tests
matifali c96782e
Renamed the data source from `jetbrains_ide` to `jetbrains_ides` for …
matifali de29c2a
Renamed the data source from `jetbrains_ide` to `jetbrains_ides` for …
matifali 283bdc3
Merge branch 'main' into jetbrains
matifali e54ca31
Merge branch 'main' into jetbrains
matifali d99c770
Refactor JetBrains module for air-gapped support
matifali 0531115
Fix JetBrains URL for Toolbox 2.6.3+
matifali b7cc89c
Fix JetBrains URL to include agent_id parameter
matifali ec5aa85
Update JetBrains IDE build numbers
matifali b230b2a
Merge branch 'main' into jetbrains
matifali 2a48544
Fix JetBrains icon path in README
matifali c251fbf
Add JetBrains icon and update README
matifali ef8ad09
Add agent_name to JetBrains module URLs
matifali 15fcf0e
Update JetBrains version requirements in README
matifali 34346e7
Update JetBrains module readme for clarity
matifali d9cc3fc
Add JetBrains IDE list image to README
matifali 56a01f2
Fix redundant entry in JetBrains README
matifali c977142
Merge branch 'main' into jetbrains
matifali File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,149 @@ | ||
--- | ||
display_name: JetBrains Toolbox | ||
description: Add JetBrains IDE integrations to your Coder workspaces with configurable options. | ||
icon: ../../../../.icons/jetbrains.svg | ||
maintainer_github: coder | ||
verified: true | ||
tags: [ide, jetbrains, parameter] | ||
--- | ||
|
||
# JetBrains IDEs | ||
|
||
This module adds JetBrains IDE buttons to launch IDEs directly from the dashboard by integrating with the JetBrains Toolbox. | ||
|
||
```tf | ||
module "jetbrains" { | ||
count = data.coder_workspace.me.start_count | ||
source = "registry.coder.com/coder/jetbrains/coder" | ||
version = "1.0.0" | ||
agent_id = coder_agent.example.id | ||
folder = "/home/coder/project" | ||
} | ||
``` | ||
|
||
 | ||
|
||
> [!IMPORTANT] | ||
> This module requires Coder version 2.24+ and [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/) version 2.7 or higher. | ||
|
||
> [!WARNING] | ||
> JetBrains recommends a minimum of 4 CPU cores and 8GB of RAM. | ||
> Consult the [JetBrains documentation](https://www.jetbrains.com/help/idea/prerequisites.html#min_requirements) to confirm other system requirements. | ||
|
||
## Examples | ||
|
||
### Pre-configured Mode (Direct App Creation) | ||
|
||
When `default` contains IDE codes, those IDEs are created directly without user selection: | ||
|
||
```tf | ||
module "jetbrains" { | ||
count = data.coder_workspace.me.start_count | ||
source = "registry.coder.com/coder/jetbrains/coder" | ||
version = "1.0.0" | ||
agent_id = coder_agent.example.id | ||
folder = "/home/coder/project" | ||
default = ["PY", "IU"] # Pre-configure GoLand and IntelliJ IDEA | ||
} | ||
``` | ||
|
||
### User Choice with Limited Options | ||
|
||
```tf | ||
module "jetbrains" { | ||
count = data.coder_workspace.me.start_count | ||
source = "registry.coder.com/coder/jetbrains/coder" | ||
version = "1.0.0" | ||
agent_id = coder_agent.example.id | ||
folder = "/home/coder/project" | ||
# Show parameter with limited options | ||
options = ["IU", "PY"] # Only these IDEs are available for selection | ||
} | ||
``` | ||
|
||
### Early Access Preview (EAP) Versions | ||
|
||
```tf | ||
module "jetbrains" { | ||
count = data.coder_workspace.me.start_count | ||
source = "registry.coder.com/coder/jetbrains/coder" | ||
version = "1.0.0" | ||
agent_id = coder_agent.example.id | ||
folder = "/home/coder/project" | ||
default = ["IU", "PY"] | ||
channel = "eap" # Use Early Access Preview versions | ||
major_version = "2025.2" # Specific major version | ||
} | ||
``` | ||
|
||
### Custom IDE Configuration | ||
|
||
```tf | ||
module "jetbrains" { | ||
count = data.coder_workspace.me.start_count | ||
source = "registry.coder.com/coder/jetbrains/coder" | ||
version = "1.0.0" | ||
agent_id = coder_agent.example.id | ||
folder = "/workspace/project" | ||
|
||
# Custom IDE metadata (display names and icons) | ||
ide_config = { | ||
"IU" = { | ||
name = "IntelliJ IDEA" | ||
icon = "/custom/icons/intellij.svg" | ||
build = "251.26927.53" | ||
} | ||
"PY" = { | ||
name = "PyCharm" | ||
icon = "/custom/icons/pycharm.svg" | ||
build = "251.23774.211" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### Single IDE for Specific Use Case | ||
|
||
```tf | ||
module "jetbrains_pycharm" { | ||
count = data.coder_workspace.me.start_count | ||
source = "registry.coder.com/coder/jetbrains/coder" | ||
version = "1.0.0" | ||
agent_id = coder_agent.example.id | ||
folder = "/workspace/project" | ||
|
||
default = ["PY"] # Only PyCharm | ||
|
||
# Specific version for consistency | ||
major_version = "2025.1" | ||
channel = "release" | ||
} | ||
``` | ||
|
||
## Behavior | ||
|
||
### Parameter vs Direct Apps | ||
|
||
- **`default = []` (empty)**: Creates a `coder_parameter` allowing users to select IDEs from `options` | ||
- **`default` with values**: Skips parameter and directly creates `coder_app` resources for the specified IDEs | ||
|
||
### Version Resolution | ||
|
||
- Build numbers are fetched from the JetBrains API for the latest compatible versions when internet access is available | ||
- If the API is unreachable (air-gapped environments), the module automatically falls back to build numbers from `ide_config` | ||
- `major_version` and `channel` control which API endpoint is queried (when API access is available) | ||
|
||
## Supported IDEs | ||
|
||
All JetBrains IDEs with remote development capabilities: | ||
|
||
- [CLion (`CL`)](https://www.jetbrains.com/clion/) | ||
- [GoLand (`GO`)](https://www.jetbrains.com/go/) | ||
- [IntelliJ IDEA Ultimate (`IU`)](https://www.jetbrains.com/idea/) | ||
- [PhpStorm (`PS`)](https://www.jetbrains.com/phpstorm/) | ||
- [PyCharm Professional (`PY`)](https://www.jetbrains.com/pycharm/) | ||
- [Rider (`RD`)](https://www.jetbrains.com/rider/) | ||
- [RubyMine (`RM`)](https://www.jetbrains.com/ruby/) | ||
- [RustRover (`RR`)](https://www.jetbrains.com/rust/) | ||
- [WebStorm (`WS`)](https://www.jetbrains.com/webstorm/) | ||
- [WebStorm (`WS`)](https://www.jetbrains.com/webstorm/) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.