eclipse-theia / theia-ide

The Eclipse IDE is a modern and open IDE for cloud and desktop. The Theia IDE is based on the Theia platform. The Theia IDE is available as a downloadable desktop application. You can also try the latest version of the Theia IDE online. For more details, see the Readme below.
https://theia-ide.org/#theiaide
MIT License
343 stars 129 forks source link

Update README.md: add note to start clean after dependency updates. #401

Open seltzered opened 1 month ago

seltzered commented 1 month ago

What it does

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. This is to help those running into the issue where they notice a runtime issue on electron build of "Error module did not self-register" ( drivelist.node ).

The jenkinsfile for what is (was?) the 'next' build has also done this according to https://github.com/eclipse-theia/theia-blueprint/issues/349#issuecomment-2364956584 . As a casual developer (not using Jenkins) 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 (see https://github.com/eclipse-theia/theia/issues/13126 ). There may be some better ways to handle this but the git clean -xfd approach has seemingly been more reliable and think there should be some note to help those getting started with theia-blueprint.

How to test

I suspect the issue others experience can be reproduced by:

Review checklist

NOTE: This is a readme change just suggesting to clean out data before build after changes. Open to feedback if there's a better way to approach this, but so far from my brief tests doing git clean -xfd seems to help reduce the chance of encountering the ""Error module did not self-register" runtime issue after making changes (either by updating dependencies by hand or by merging/pulling to newer commits).

Reminder for reviewers