From c513537c55b446364f6fdc104dc27adfd3ca45de Mon Sep 17 00:00:00 2001 From: Vivek Gani Date: Sat, 21 Sep 2024 17:26:54 -0500 Subject: [PATCH] Update README.md build steps with note to start clean after dependency changes/pulling to a new commit Proposing a note in the readme for those doing manual builds to run `git clean -xfd` when updating to a newer commit of the repo, particularly when updating dependencies. The jenkinsfile already does this, see https://github.com/eclipse-theia/theia-blueprint/issues/349#issuecomment-2364956584 for more info. As a casual hobbyist developer who comes back to working on Theia intermittently this issue has come back to frustrate me for a while and seems to have come up in other conversations. There may be some better ways to handle this but the `git clean -xfd` approach has seemingly been more reliable. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b763356eb..585a132f7 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,8 @@ Documentation on how to package Theia as a Desktop Product may be found [here](h For development and casual testing of the Eclipse Theia IDE, one can build it in "dev" mode. This permits building the IDE on systems with less resources, like a Raspberry Pi 4B with 4GB of RAM. +NOTE: If manually building after updating dependencies or pulling to a newer commit, run `git clean -xfd` to help avoid runtime conflicts. + ```sh # Build "dev" version of the app. Its quicker, uses less resources, # but the front end app is not "minified"