From 22a5fe17bf0cf82bb8461f07bd6eba6945ccda49 Mon Sep 17 00:00:00 2001 From: Daniel Marques Date: Tue, 9 Jul 2024 09:13:56 +0100 Subject: [PATCH] More info about CODY_PATH on Contributing.md --- CONTRIBUTING.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6664bf147e..d201847b9b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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= ./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= ./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