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.

Sign up for GitHub

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

Jump to bottom

More info about CODY_PATH on Contributing.md #1896

Merged
merged 1 commit into from
Jul 9, 2024
Merged

More info about CODY_PATH on Contributing.md #1896

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,19 @@ our [issue tracker](https://github.com/sourcegraph/cody/issues/new/choose).

### Running

| What | Command |
|------------------------------------------------------------------|--------------------------------------------------------------------------|
| Run the plugin locally | `./gradlew :runIde` |
| Run the plugin locally with fresh build of Cody | `./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of a local clone of Cody | `CODY_DIR=<path_to_cody> ./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of Code Search assets | `./gradlew -PforceCodeSearchBuild=true :runIde` |
| Run the plugin locally with different IntelliJ version | `./gradlew -PplatformVersion=2023.1 :runIde` |
| Build Code Search assets (separate terminal) | `pnpm build` |
| Continuously re-build Code Search assets (separate terminal) | `pnpm watch` |
| Code Search "Find with Sourcegraph" window | `pnpm standalone && open http://localhost:3000/` |
| Build deployable plugin | `./gradlew buildPlugin` (artifact is generated in `build/distributions`) |
| Reformat Java and Kotlin sources | `./gradlew spotlessApply` |
| Debug agent JSON-RPC communication | `tail -f build/sourcegraph/cody-agent-trace.json` |
| What | Command |
|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| Run the plugin locally | `./gradlew :runIde` |
| Run the plugin locally with fresh build of Cody | `./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of a local clone of Cody (CODY_DIR needs to be an absolute path) | `CODY_DIR=<path_to_cody> ./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of Code Search assets | `./gradlew -PforceCodeSearchBuild=true :runIde` |
| Run the plugin locally with different IntelliJ version | `./gradlew -PplatformVersion=2023.1 :runIde` |
| Build Code Search assets (separate terminal) | `pnpm build` |
| Continuously re-build Code Search assets (separate terminal) | `pnpm watch` |
| Code Search "Find with Sourcegraph" window | `pnpm standalone && open http://localhost:3000/` |
| Build deployable plugin | `./gradlew buildPlugin` (artifact is generated in `build/distributions`) |
| Reformat Java and Kotlin sources | `./gradlew spotlessApply` |
| Debug agent JSON-RPC communication | `tail -f build/sourcegraph/cody-agent-trace.json` |

### Editor config

Expand Down
Loading