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

doc: Document the starlark debugger #6899

Merged
merged 2 commits into from
Oct 16, 2024
Merged
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
24 changes: 24 additions & 0 deletions docs/starlark_debugger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Debugging Starlark with the IntelliJ Plugin

To debug Starlark, you need to create a `build` run configuration. You can do this in two ways: manually create a new configuration or reuse an existing one.

## Method 1: Create a Run Configuration Manually

1. Open the **Run Configurations** menu.
2. Click the `+` icon to add a new configuration.
3. Select **Bazel Command** from the list.
4. Enter the target expression in the **Target** field.
5. Set the **Bazel Command** field to `build`.

## Method 2: Reuse an Existing Run Configuration

1. Run the target using an existing configuration.
2. Open the **Run Configurations** editor.
3. Change the **Command** field to `build`.
4. Run the configuration again.

**Important:** Before starting the debugger, ensure you have modified something in the Starlark file. If no changes are made, Bazel will use the analysis cache and skip executing the Starlark code.

## Demo: Showing Both Methods
https://github.com/user-attachments/assets/959b3d53-f79b-4329-bd3b-74d328af761a

Loading