You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/docs/docs/contributing.md
+19-2Lines changed: 19 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,23 @@ If that is the situation for you, you can instead use `npm run build-serial` to
29
29
Also, if you are only working on one package, you can `npm run build` and `npm run test` from within the subdirectory.
30
30
Finally, you can simply `npm start` inside of the `playground` directory to test changes if you have already built all of your packages, without needing to watch all of the packages via the root directory `npm start`.
31
31
32
+
### Troubleshooting build failures
33
+
34
+
Sometimes your local builds fail and you can't figure out why. This is most likely to happen after rebase to `main` due
35
+
to `package.json` changes upstream. There are two commands you can use to (hopefully) get your environment back to a
36
+
working state. Try running the following two commands:
37
+
38
+
```bash
39
+
npm run refresh-node-modules
40
+
npm run clean-build
41
+
```
42
+
43
+
The first command will delete all of the `node_modules` directories in the environment and then rerun `npm install`.
44
+
The second command cleans up the typescript build cache files before retrying the build.
45
+
46
+
Worst case scenario when neither of those commands work, try deleting the `package-lock.json` and the entire `.nx` cache
47
+
directory and rerun the commands again.
48
+
32
49
## Cloud builds
33
50
34
51
When building in environments with limited memory, such as Netlify, it's recommended to use `npm run build-serial` that builds the packages serially.
@@ -123,7 +140,7 @@ Code coverage reports are currently available only for the `@rjsf/core` theme pa
123
140
They are generated using [nyc](https://github.com/istanbuljs/nyc) each time the `npm test-coverage` script is run.
124
141
The full report can be seen by opening `./coverage/lcov-report/index.html`.
125
142
126
-
#### Utils and validator-ajvX code coverage
143
+
#### Utils and validator-ajv8 code coverage
127
144
128
145
100% code coverage is required by the `@rjsf/utils` and `@rjsf/validator-ajv8` tests.
129
146
If you make changes to those libraries, you will have to maintain that coverage, otherwise the tests will fail.
@@ -133,7 +150,7 @@ If you make changes to those libraries, you will have to maintain that coverage,
133
150
## Releasing
134
151
135
152
To release, go to the main branch (NOT a fork) and then create a new branch with the version number (with an `rc` prefix instead of `v`).
136
-
For instance if you are about to create the new `5.100.10` branch, then you would run the following commands:
153
+
For instance if you are about to create the new `6.100.10` branch, then you would run the following commands:
0 commit comments