Skip to content

Commit

Permalink
Add updating dependencies section to devGuide
Browse files Browse the repository at this point in the history
  • Loading branch information
ang-zeyu committed Jun 15, 2020
1 parent a57bcab commit 928e2d2
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/devGuide/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,20 @@ It is also possible to auto-fix some (not all) style errors:

ESLint has [integrations with popular editors](https://eslint.org/docs/user-guide/integrations). They offer features such as "fix errors on save", which will make development smoother.
</box>

## Updating dependencies

We use `npm install <package folder>` to <tooltip content="take a look under the command in the link!">[hoist](https://docs.npmjs.com/cli/install)</tooltip> subpackage dependencies to the root `node_modules`.

This avoids having to duplicate dependencies between the different `package.json` config files where possible,
and having to run `npm install` on each package in our CI workflow.

Hence, when updating dependencies of sub packages, be sure to rerun the above `npm install <package folder>` command.

If the dependency <tooltip content="i.e. also listed under the root `package.json`">is also used</tooltip> in the root package, make sure to update it's <tooltip content="as listed in the `package.json` file">version number</tooltip> as well!

<box type="warning">

When updating dependencies of the *root* package, be sure to still check whether any subpackages list this as a dependency!
If so, follow the above process as well.
</box>

0 comments on commit 928e2d2

Please sign in to comment.