aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Vijay A <avijayr@protonmail.com>2021-07-28 11:58:55 +0530
committerLibravatar Vijay A <avijayr@protonmail.com>2021-07-28 11:58:55 +0530
commitf79ac23cf0e27549e8ad8126227cbf524a2b0bfe (patch)
tree6c097a125ffc6dc129db9ecc7a57fa1e2821759f
parentTag the main ferdi repo when bumping the version (helpful while generating co... (diff)
downloadferdium-app-f79ac23cf0e27549e8ad8126227cbf524a2b0bfe.tar.gz
ferdium-app-f79ac23cf0e27549e8ad8126227cbf524a2b0bfe.tar.zst
ferdium-app-f79ac23cf0e27549e8ad8126227cbf524a2b0bfe.zip
Update documentation for new contributors for system dependencies. [skip ci]
-rw-r--r--.github/workflows/dependency-updates.yml5
-rw-r--r--.github/workflows/ferdi-builds.yml15
-rw-r--r--CONTRIBUTING.md15
-rw-r--r--Dockerfile3
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:
44 uses: actions/setup-node@v2 44 uses: actions/setup-node@v2
45 with: 45 with:
46 node-version: 14.17.3 46 node-version: 14.17.3
47 - name: Uninstall locally and reinstall node-gyp globally 47 - name: Uninstall locally and reinstall global npm modules
48 run: | 48 run: |
49 npm uninstall node-gyp 49 npm uninstall node-gyp
50 npm i -g node-gyp@8.1.0 50 npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0
51 npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0
51 - name: Install node dependencies recursively 52 - name: Install node dependencies recursively
52 run: npx lerna bootstrap 53 run: npx lerna bootstrap
53 - name: Update submodules 54 - 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:
138 run: | 138 run: |
139 sudo rm -Rf /Library/Developer/CommandLineTools/SDKs/* 139 sudo rm -Rf /Library/Developer/CommandLineTools/SDKs/*
140 sudo xcode-select -s "/Applications/Xcode_12.4.app" 140 sudo xcode-select -s "/Applications/Xcode_12.4.app"
141 - name: Uninstall locally and reinstall node-gyp globally 141 - name: Uninstall locally and reinstall global npm modules
142 run: | 142 run: |
143 npm uninstall node-gyp 143 npm uninstall node-gyp
144 npm i -g node-gyp@8.1.0 144 npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0
145 npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0
145 - name: Fix corrupted node cache 146 - name: Fix corrupted node cache
146 run: npm cache clean --force 147 run: npm cache clean --force
147 - name: Install node dependencies recursively 148 - name: Install node dependencies recursively
@@ -231,10 +232,11 @@ jobs:
231 uses: actions/setup-node@v2 232 uses: actions/setup-node@v2
232 with: 233 with:
233 node-version: 14.17.3 234 node-version: 14.17.3
234 - name: Uninstall locally and reinstall node-gyp globally 235 - name: Uninstall locally and reinstall global npm modules
235 run: | 236 run: |
236 npm uninstall node-gyp 237 npm uninstall node-gyp
237 npm i -g node-gyp@8.1.0 238 npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0
239 npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0
238 - name: Fix corrupted node cache 240 - name: Fix corrupted node cache
239 run: npm cache clean --force 241 run: npm cache clean --force
240 - name: Install node dependencies recursively 242 - name: Install node dependencies recursively
@@ -320,10 +322,11 @@ jobs:
320 uses: actions/setup-node@v2 322 uses: actions/setup-node@v2
321 with: 323 with:
322 node-version: 14.17.3 324 node-version: 14.17.3
323 - name: Uninstall locally and reinstall node-gyp globally 325 - name: Uninstall locally and reinstall global npm modules
324 run: | 326 run: |
325 npm uninstall node-gyp 327 npm uninstall node-gyp
326 npm i -g node-gyp@8.1.0 328 npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0
329 npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0
327 shell: bash 330 shell: bash
328 - name: Fix corrupted node cache 331 - name: Fix corrupted node cache
329 run: npm cache clean --force 332 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 @@
18 - [Debian/Ubuntu](#debianubuntu) 18 - [Debian/Ubuntu](#debianubuntu)
19 - [Fedora](#fedora) 19 - [Fedora](#fedora)
20 - [Windows](#windows) 20 - [Windows](#windows)
21 - [node-gyp](#node-gyp)
21 - [Lerna](#lerna) 22 - [Lerna](#lerna)
22 - [Clone repository with submodule](#clone-repository-with-submodule) 23 - [Clone repository with submodule](#clone-repository-with-submodule)
23 - [Local caching of dependencies](#local-caching-of-dependencies) 24 - [Local caching of dependencies](#local-caching-of-dependencies)
@@ -61,9 +62,7 @@ Currently, these are the combinations of system dependencies that work for MacOS
61node -v 62node -v
62v14.17.3 63v14.17.3
63npm -v 64npm -v
646.14.12 656.14.13
65node-gyp -v
66v8.1.0
67``` 66```
68 67
69#### Git 68#### Git
@@ -92,10 +91,18 @@ Please make sure you run this command as an administrator:
92npm i -g windows-build-tools --vs2015 91npm i -g windows-build-tools --vs2015
93``` 92```
94 93
94#### node-gyp
95
96We need `node-gyp` to be able to compile any native dependencies
97
98```bash
99npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0
100```
101
95#### Lerna 102#### Lerna
96 103
97```bash 104```bash
98npm i -g lerna@4.0.0 105npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0
99``` 106```
100 107
101### Clone repository with submodule 108### 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
21COPY package*.json ./ 21COPY package*.json ./
22COPY lerna.json ./ 22COPY lerna.json ./
23 23
24RUN npm i -g node-gyp@8.1.0 24RUN npm i -g node-gyp@8.1.0 \
25 && npm i -g lerna@4.0.0
25 26
26COPY . . 27COPY . .
27 28