Simplify onboarding instructions for engine & project-manager developers #7181
Conversation
JaroslavTulach
added
the
CI: No changelog needed
JaroslavTulach
requested review from
radeusgd,
mwu-tow,
farmaazon,
jdunkerley and
GregoryTravis
|
|
||
| ```bash | ||
| $ ./run ide start --wasm-profile dev --external-backend | ||
| enso$ ./run gui watch --skip-wasm-opt |
There was a problem hiding this comment.
This is the command I am using the most frequently. What do others use? The original ./run ide start ...? What's the most suitable way to start the IDE for developers not primarily focused on developing the IDE? What shall we put into the documentation?
| ``` | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
I do remember that setting all these editions, and symlinks was a pain when I was onboarding myself. I goal is to remove that from the CONTRIBUTING.md documentation altogether...
|
|
||
| ```powershell | ||
| sbt.bat buildEngineDistribution | ||
| sbt:enso> runProjectManagerDistribution --debug |
There was a problem hiding this comment.
This --debug actually debugs the engine. The instructions how to debug the project manager itself are given at
An alternative would be to require an argument to the --debug option. Either engine or project-manager and based on that debug the right process in the system.
Btw. to support debugging project-manager we would need to debug the JVM version (not the native image version).
| ): Boolean = { | ||
| import scala.collection.JavaConverters._ | ||
|
|
||
| val enso = distributionRoot / "bin" / "project-manager" |
There was a problem hiding this comment.
To continue the idea of the previous comment here we would need to invoke JVM with project-manager.jar. Necessary for debugging the project manager, but also useful for plain execution as building native image takes a lot of time.
| ) | ||
| runProjectManagerDistribution := { | ||
| buildEngineDistribution.value | ||
| buildProjectManagerDistribution.value |
There was a problem hiding this comment.
If we wanted to run the project manager in JVM mode we'd need to replace this buildProjectManagerDistribution.value with a dependency on "something" produced by #7153. Do you know what that'd be, @hubertp?
...manager/src/main/scala/org/enso/runtimeversionmanager/components/RuntimeVersionManager.scala
Show resolved
Hide resolved
Co-authored-by: Radosław Waśko <radoslaw.wasko@enso.org>
JaroslavTulach
force-pushed
the
wip/jtulach/RunProjectManagerDistribution
branch
from
916cc78
to
ce7e4e6
Compare
…jectManagerDistribution
JaroslavTulach
added
the
CI: Keep up to date
JaroslavTulach
added
the
CI: Ready to merge
Pull Request Description
The current instructions to build, use and debug
project-managerand its engine/ls process are complicated and require a lot of symlinks to properly point to each other. This pull requests simplifies all of that by introduction ofENSO_ENGINE_PATHandENSO_JVM_PATHenvironment variables. Then it hides all the complexity behind a simple sbt command:runProjectManagerDistribution --debug.Important Notes
I decided to tackle this problem as I have three repositories with different branches of Enso and switching between them requires me to mangle the symlinks. I hope I will not need to do that anymore with the introduction of the
runProjectManagerDistributioncommand.Checklist
Please ensure that the following checklist has been satisfied before submitting the PR:
Scala,