Skip to content

Add contributor docs troubleshooting entry for .yarn-state.yml CI failure #915

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add contributor docs troubleshooting entry for .yarn-state.yml CI failure #915

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions docs/contributor_guide/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# Troubleshooting

- Setup of development environment hangs indefinitely when running the
`dev-install.py` step, specifically on the Yarn linking step.
- This may be caused by having a `.gitignore` file in your home directory.
This is a [known issue with Nx](https://github.com/nrwl/nx/issues/27494).
The [only known workaround](https://github.com/nrwl/nx/issues/27494#issuecomment-2481207598) is to remove the `.gitignore` file from your home directory or to work in a location outside of the home directory tree.

- Every UI test fails after 60 seconds due to timeout.
- This could be caused by having a JupyterLab instance already running at port
`:8888`. Please ensure that there is nothing running at <http://localhost:8888/lab>
before running tests.
## Setup of development environment hangs indefinitely when running the `dev-install.py` step, specifically on the Yarn linking step.

This may be caused by having a `.gitignore` file in your home directory.
This is a [known issue with Nx](https://github.com/nrwl/nx/issues/27494).
The [only known workaround](https://github.com/nrwl/nx/issues/27494#issuecomment-2481207598)
is to remove the `.gitignore` file from your home directory or to work in a location
outside of the home directory tree.

## Every UI test fails after 60 seconds due to timeout.

This could be caused by having a JupyterLab instance already running at port `:8888`.
Please ensure that there is nothing running at <http://localhost:8888/lab> before
running tests.

## Build fails in CI with error about `.yarn-state.yml`

```
Error: ENOENT: no such file or directory, unlink '/home/runner/work/jupytergis/jupytergis/node_modules/.yarn-state.yml'
```

Re-running the job can get you past this error.
Loading