- updated docs for the new release process and added nuke-build-env

Author: heath-freenome

package.json

@@ -24,7 +24,8 @@
     "refresh-node-modules": "rimraf packages/*/node_modules && rimraf node_modules && npm install",
     "commit-package-changes": "git add package-lock.json packages/*/package*.json && cross-env CI=skipPrecommit git commit -m 'updated package*.json after versioning' && git push",
     "post-versioning": "echo 'This will take a while...' && npm run bump-peer-deps && npm run refresh-node-modules && npm run commit-package-changes && npm run update-version-tags",
-    "update-version-tags": "git tag -f $(node scripts/get-version-tag.js) && git push -f origin $(node scripts/get-version-tag.js)"
+    "update-version-tags": "git tag -f $(node scripts/get-version-tag.js) && git push -f origin $(node scripts/get-version-tag.js)",
+    "nuke-build-env": "rimraf .nx && rimraf package-lock.json"
   },
   "license": "Apache-2.0",
   "homepage": "https://github.com/rjsf-team/react-jsonschema-form",

packages/docs/docs/contributing.md

@@ -43,8 +43,7 @@ npm run clean-build
 The first command will delete all of the `node_modules` directories in the environment and then rerun `npm install`.
 The second command cleans up the typescript build cache files before retrying the build.
 
-Worst case scenario when neither of those commands work, try deleting the `package-lock.json` and the entire `.nx` cache
-directory and rerun the commands again.
+Worst case scenario when neither of those commands work, try running `npm run nuke-build-env` and then rerun the two commands.
 
 ## Cloud builds
 
@@ -154,19 +153,16 @@ For instance if you are about to create the new `6.100.10` branch, then you woul
 
 ```bash
 git checkout -b rc6.100.10
-git push
 npx nx release version --git-tag
-npm run post-versioning
+git commit -m "Releasing 6.100.10"
+git push
+npm run update-version-tags
 ```
 
 Make sure you use [semver](https://semver.org/) for version numbering when selecting the version.
-The `npx nx release version --git-tag` command will create a new version tag and push it to GitHub.
-
-The `npm run post-versioning` script will update the peer dependencies in all of the `packages/*/package.json` files if necessary.
-It will then clean up the `node_modules` directories and rerun `npm install` to update the `package-lock.json` files.
-Finally, it creates and pushes a new commit with those `package.json` and `package-lock.json` files up to GitHub.
-
-> NOTE: this command will take a while, be patient
+The `npx nx release version --git-tag` command will update the `package*.josn` files and create a new version tag.
+Committing and pushing the branch will allow you to create the PR on GitHub.
+The `npm run update-version-tags` will push the tags up to GitHub.
 
 Then, make a PR to main. Merge the PR into main -- make sure you use "merge commit", not squash and merge, so that
 the original commit where the tag was based on is still present in the main branch.
@@ -181,6 +177,21 @@ The package is published through an automation token belonging to the
 [rjsf-bot](https://www.npmjs.com/~rjsf-bot) user on npm. This token
 is stored as the `NPM_TOKEN` secret on GitHub Actions.
 
+### Updating the peer dependencies for new features in a minor release
+
+If a set of changes added new features or APIs that require updating downstream peer dependencies, then run the following
+command:
+
+```bash
+npm run post-versioning
+```
+
+The `npm run post-versioning` script will update the peer dependencies in all of the `packages/*/package.json` files if necessary.
+It will then clean up the `node_modules` directories and rerun `npm install` to update the `package-lock.json` files.
+Finally, it creates and pushes a new commit with those `package.json` and `package-lock.json` files up to GitHub.
+
+> NOTE: this command will take a while, be patient
+
 ### Releasing docs
 
 Docs are automatically published to GitHub Pages when the `main` branch is updated.