From f79ac23cf0e27549e8ad8126227cbf524a2b0bfe Mon Sep 17 00:00:00 2001 From: Vijay A Date: Wed, 28 Jul 2021 11:58:55 +0530 Subject: Update documentation for new contributors for system dependencies. [skip ci] --- .github/workflows/dependency-updates.yml | 5 +++-- .github/workflows/ferdi-builds.yml | 15 +++++++++------ CONTRIBUTING.md | 15 +++++++++++---- Dockerfile | 3 ++- 4 files changed, 25 insertions(+), 13 deletions(-) diff --git a/.github/workflows/dependency-updates.yml b/.github/workflows/dependency-updates.yml index eca47ee90..a9406df23 100644 --- a/.github/workflows/dependency-updates.yml +++ b/.github/workflows/dependency-updates.yml @@ -44,10 +44,11 @@ jobs: uses: actions/setup-node@v2 with: node-version: 14.17.3 - - name: Uninstall locally and reinstall node-gyp globally + - name: Uninstall locally and reinstall global npm modules run: | npm uninstall node-gyp - npm i -g node-gyp@8.1.0 + npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0 + npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0 - name: Install node dependencies recursively run: npx lerna bootstrap - name: Update submodules diff --git a/.github/workflows/ferdi-builds.yml b/.github/workflows/ferdi-builds.yml index b2d6f9b3f..b5aaf13b8 100644 --- a/.github/workflows/ferdi-builds.yml +++ b/.github/workflows/ferdi-builds.yml @@ -138,10 +138,11 @@ jobs: run: | sudo rm -Rf /Library/Developer/CommandLineTools/SDKs/* sudo xcode-select -s "/Applications/Xcode_12.4.app" - - name: Uninstall locally and reinstall node-gyp globally + - name: Uninstall locally and reinstall global npm modules run: | npm uninstall node-gyp - npm i -g node-gyp@8.1.0 + npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0 + npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0 - name: Fix corrupted node cache run: npm cache clean --force - name: Install node dependencies recursively @@ -231,10 +232,11 @@ jobs: uses: actions/setup-node@v2 with: node-version: 14.17.3 - - name: Uninstall locally and reinstall node-gyp globally + - name: Uninstall locally and reinstall global npm modules run: | npm uninstall node-gyp - npm i -g node-gyp@8.1.0 + npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0 + npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0 - name: Fix corrupted node cache run: npm cache clean --force - name: Install node dependencies recursively @@ -320,10 +322,11 @@ jobs: uses: actions/setup-node@v2 with: node-version: 14.17.3 - - name: Uninstall locally and reinstall node-gyp globally + - name: Uninstall locally and reinstall global npm modules run: | npm uninstall node-gyp - npm i -g node-gyp@8.1.0 + npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0 + npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0 shell: bash - name: Fix corrupted node cache run: npm cache clean --force diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d99822ace..a95dbbc8f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,7 @@ - [Debian/Ubuntu](#debianubuntu) - [Fedora](#fedora) - [Windows](#windows) + - [node-gyp](#node-gyp) - [Lerna](#lerna) - [Clone repository with submodule](#clone-repository-with-submodule) - [Local caching of dependencies](#local-caching-of-dependencies) @@ -61,9 +62,7 @@ Currently, these are the combinations of system dependencies that work for MacOS node -v v14.17.3 npm -v -6.14.12 -node-gyp -v -v8.1.0 +6.14.13 ``` #### Git @@ -92,10 +91,18 @@ Please make sure you run this command as an administrator: npm i -g windows-build-tools --vs2015 ``` +#### node-gyp + +We need `node-gyp` to be able to compile any native dependencies + +```bash +npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0 +``` + #### Lerna ```bash -npm i -g lerna@4.0.0 +npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0 ``` ### Clone repository with submodule diff --git a/Dockerfile b/Dockerfile index 71fca5d22..ef4d1dbe0 100644 --- a/Dockerfile +++ b/Dockerfile @@ -21,7 +21,8 @@ WORKDIR /usr/src/ferdi COPY package*.json ./ COPY lerna.json ./ -RUN npm i -g node-gyp@8.1.0 +RUN npm i -g node-gyp@8.1.0 \ + && npm i -g lerna@4.0.0 COPY . . -- cgit v1.2.3-54-g00ecf