Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve development instructions in Readme file #4770

Merged
merged 1 commit into from
Feb 26, 2024

Conversation

vlad-tim
Copy link
Contributor

@vlad-tim vlad-tim commented Feb 26, 2024

Contribution checklist

Brief description

This change improves troubleshooting instructions for developers who encounter build issues.

For context, when I did git bisect and ran into numerous unexpected build issues when switching from one git revision to another and then attempting to build the project, error example:

error TS7016: Could not find a declaration file for module '@hcengineering/server-request'

In order to resolve them I tried multiple action including:

  • Using troubleshooting tips from the existing Readme, in particular rush build --clean.
  • Complete deletion of docker files (containers, images, volumes, etc) by removing contents of /var/lib/docker/ directory.
  • Cloning a fresh version of the repository from git.
  • Rebooting the machine.
  • Using rush rebuild and rush purge.
  • Manually deleting the build cache.

The last action turned out to be the only action that reliably overcame unexpected build issues for me.

Moreover, I believe that the existing advice to run rush build --clean is misleading because the cache is still used according to the output of this command:

[user@huly] ➜  ~/workshops/platform git:(improve-dev-readme) ✗ rush build --clean                                                                                                                                              

Rush Multi-Project Build Tool 5.115.0 - https://rushjs.io
Node.js version is 20.11.1 (LTS)

Starting "rush build"

Analyzing repo state... DONE (0.07 seconds)

Executing a maximum of 2 simultaneous processes...

==[ @hcengineering/platform-rig (build) ]========================[ 1 of 225 ]==
"@hcengineering/platform-rig (build)" did not define any work.

==[ @hcengineering/platform (build) ]============================[ 2 of 225 ]==
"@hcengineering/platform (build)" was restored from the build cache.

==[ @hcengineering/apm (build) ]=================================[ 3 of 225 ]==
"@hcengineering/apm (build)" was restored from the build cache.
...

This Readme update is useful for new developers because it may save them a lot of time if they run into the same problems like I did.

Checklist

(all boxes are checked as N/A for a documentation change)

  • - UI test added to added/changed functionality?
  • - Screenshot is added to PR if applicable ?
  • - Does a local formatting is applied (rush format)
  • - Does a local svelte-check is applied (rush svelte-check)
  • - Does a local UI tests are executed UI Testing
  • - Does the code work? Check whether function and logic are correct.
  • - Does Changelog.md is updated with changes?
  • - Does the translations are up to date?
  • - Does it well tested?
  • - Tested for Chrome.
  • - Tested for Safari.
  • - Go through the changed code looking for typos, TODOs, commented LOCs, debugging pieces of code, etc.
  • - Rebase your branch onto master and upstream branch
  • - Is there any redundant or duplicate code?
  • - Are required links are linked to PR?
  • - Does new code is well documented ?

Related issues

#4757

Contributor requirements

  • - Sign-off is provided. DCO
  • - GPG Signature is provided. GPG

Sorry, something went wrong.

Signed-off-by: Vlad Timofeev <11474041+vlad-timofeev@users.noreply.github.com>
@haiodo
Copy link
Member

haiodo commented Feb 26, 2024

Hi @vlad-timofeev, really sorry for this inconveniences, thanks for PR in any case. I've just missed to update readme, since we switched to build using esbuild mostly and move typescript validation into rush validate phase.
So will update readme ASAP.
Thanks.

@haiodo haiodo merged commit 57b1575 into hcengineering:main Feb 26, 2024
3 checks passed
@vlad-tim
Copy link
Contributor Author

Thanks for the information and no worries - I did not mean to complain.

tjaoc pushed a commit to tjaoc/huly that referenced this pull request Mar 5, 2024
Signed-off-by: Vlad Timofeev <11474041+vlad-timofeev@users.noreply.github.com>
Signed-off-by: Tiago Cruz <tcruz@netic.io>
tjaoc pushed a commit to tjaoc/huly that referenced this pull request Mar 5, 2024
Signed-off-by: Vlad Timofeev <11474041+vlad-timofeev@users.noreply.github.com>
Signed-off-by: Tiago Cruz <tcruz@netic.io>
tjaoc pushed a commit to tjaoc/huly that referenced this pull request Mar 7, 2024
Signed-off-by: Vlad Timofeev <11474041+vlad-timofeev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants