Update README.md: add note to start clean after dependency updates. #401
+2
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…y 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 eclipse-theia#349 (comment) 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
Proposing a note in the readme for those doing manual builds to run
git clean -xfdwhen 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 #349 (comment) . 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 eclipse-theia/theia#13126 ). There may be some better ways to handle this but the
git clean -xfdapproach 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 -xfdseems 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