aboutsummaryrefslogtreecommitdiffstats
path: root/packages/monorepo-scripts/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-04-27 08:11:01 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-04-27 08:11:01 +0800
commitdc19690863187a797f34a95ea824c2de9a9fabae (patch)
tree40593d3c331193fb8a0c7ceadf7fc8ae4e4c218f /packages/monorepo-scripts/README.md
parent9b535e3cec4073205c1343306829bcdec3168002 (diff)
parent47604384d4042c3c61f29a635491f8165236e763 (diff)
downloaddexon-sol-tools-dc19690863187a797f34a95ea824c2de9a9fabae.tar
dexon-sol-tools-dc19690863187a797f34a95ea824c2de9a9fabae.tar.gz
dexon-sol-tools-dc19690863187a797f34a95ea824c2de9a9fabae.tar.bz2
dexon-sol-tools-dc19690863187a797f34a95ea824c2de9a9fabae.tar.lz
dexon-sol-tools-dc19690863187a797f34a95ea824c2de9a9fabae.tar.xz
dexon-sol-tools-dc19690863187a797f34a95ea824c2de9a9fabae.tar.zst
dexon-sol-tools-dc19690863187a797f34a95ea824c2de9a9fabae.zip
Merge branch 'development' into feature/website/crypto-compare-prices
* development: Fix react type versions to avoid minor version bumps with breaking changes Update Web3 Provider Engine to 14.0.4 Remove auto-assignment of everyone to PR's Check for Yarn instead of npm Add hack comment about the use of sudo Fix lazy load component name Rename Portal and PortalMenu components to LegacyPortal and LegacyPortalMenu Remove unnecessary additional params Remove outside declaration Capitalize yarn Use path for platform independence Consolidate github personal access token env to one place: constants.ts Use methods moved to utils since now shared by multiple scripts Add comment Improve comments Add checks for the required local setup before running the publish script Add descriptions for all commands in monorepo-scripts Add removeGitTags script that can be run after a failed Lerna publish
Diffstat (limited to 'packages/monorepo-scripts/README.md')
-rw-r--r--packages/monorepo-scripts/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/packages/monorepo-scripts/README.md b/packages/monorepo-scripts/README.md
index a740ba28a..cec77a10d 100644
--- a/packages/monorepo-scripts/README.md
+++ b/packages/monorepo-scripts/README.md
@@ -2,6 +2,16 @@
This repository contains a few helpful scripts for working with this mono repo.
+#### Scripts
+
+**`yarn deps_versions`**: Since we use Lerna + Yarn workspaces, shared dependencies between packages in the monorepo get hoisted to a top-level `node_modules` directory. If two packages use different versions of the same dependency however, both get installed. To avoid having many versions of a dependency installed, we try to keep dependency versions the same across packages in the monorepo. This script will list any dependencies for which we have multiple versions installed. We can then go through them and try to consolidate to a single version where possible.
+
+**`yarn find_unused_deps`**: Sometimes we accidentally leave dependencies listed in `package.json` that are no longer being used. This script finds potential dependencies that might no longer be in use. Please verify that it is no longer in use before removing, the `depcheck` package we use under-the-hood doesn't handle some TS quirks perfectly.
+
+**`yarn remove_tags`**: Our publishing script calls `lerna publish` under-the-hood. If this command fails, it might have created new versioned git tags for each package. Removing these manually is tedious, so you can also run this command instead. Before doing so, check to see if `lerna` already created the publish commit. If so, first revert that with `git reset --hard HEAD~1`, then run this command.
+
+**`yarn test:publish`**: Execute a test-run of the publish script. This dry run won't actually publish, nor will it commit/push anything to Github.
+
## Usage
#### Dependency versions