From a695bc440f580f716dc41d100a66257d35ec3d76 Mon Sep 17 00:00:00 2001 From: Stefan Hauke Date: Tue, 2 Mar 2021 14:53:58 +0100 Subject: [PATCH] docs: dependencies update/upgrade documentation additions (branch naming, package-lock.json) --- docs/guides/upgrading-pwa.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/guides/upgrading-pwa.md b/docs/guides/upgrading-pwa.md index 699ae5a761..d16bcee253 100644 --- a/docs/guides/upgrading-pwa.md +++ b/docs/guides/upgrading-pwa.md @@ -31,6 +31,8 @@ You can also run specific subparts of it for verification. Do not upgrade too many packages at once as you can easily lose track of the process and have to start anew. +Name your GitHub branch for the dependencies update `update/...` or `upgrade/...` to run additional 'Updates' checks in the GitHub CI. + ### 0. Before the Update Check if all third-party libraries for the PWA are compatible with the new version. @@ -110,6 +112,12 @@ At the end code re-formatting and optional refactorings should reside in individ Add documentation with migration instructions to the [migration guide](./migrations.md). +### 8. Rewrite package-lock.json + +Once all dependencies updates are finished it might be a good idea to re-generate the `package-lock.json`. +For this the `node_modules` folder and the `package-lock.json` need to be removed. +Afterwards `npm install` must be run to get a new clean `package-lock.json` that can either be amended, if the dependencies update is a single update commit, or as an additional commit. + ## Security Vulnerabilities Sometimes `npm install` reports security vulnerabilities: