Skip to content

Commit aca3f78

Browse files
bors[bot]bidoubiwa
andauthored
Merge #1653
1653: Make documentation compatible with node 16 r=maryamsulemani97 a=bidoubiwa fixes #1323 This PR becomes important as node 14 entered maintenance mode and will soon be EOL. Node 16 is now the current version and soon enough node 18 will takes its place. The documentation was not compatible with node 16 because it used [`vuepress-plugin-element-tabs`](https://github.com/Kaifun/vuepress-plugin-tabs) that itself used [`node-sass`](https://www.npmjs.com/package/node-sass) that is deprecated. I created a fork of that same plugin [``@bidoubiwa/vuepress-plugin-elements-tabs`](https://github.com/bidoubiwa/vuepress-plugin-element-tabs)` that upgraded `node-sass` to `sass`. Which makes it compatible with node 16. This PR also upgrades all `actions/setup-node` from v2 to v3 as v3 uses by default node v16. A good consideration would also be to upgrade netlify node version to 16 if it is possible. Co-authored-by: Charlotte Vermandel <[email protected]> Co-authored-by: cvermand <[email protected]>
2 parents 75e2d06 + 07761fc commit aca3f78

File tree

6 files changed

+94
-520
lines changed

6 files changed

+94
-520
lines changed

Diff for: .github/workflows/check-links.yml

+24-20
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,42 @@ on:
1010
- master
1111

1212
jobs:
13+
check-builds:
14+
runs-on: ubuntu-20.04
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
node: ["14", "16"]
19+
steps:
20+
- uses: actions/checkout@v3
21+
- uses: actions/setup-node@v3
22+
with:
23+
node-version: ${{ matrix.node }}
24+
cache: "yarn"
25+
cache-dependency-path: yarn.lock
26+
- run: yarn install
27+
- run: yarn build
28+
1329
check-links:
1430
runs-on: ubuntu-20.04
1531
steps:
16-
- uses: actions/checkout@v2
17-
- uses: actions/setup-node@v2
32+
- uses: actions/checkout@v3
33+
- uses: actions/setup-node@v3
1834
with:
1935
node-version: 14
20-
registry-url: https://registry.npmjs.org/
21-
- name: Cache dependencies
22-
uses: actions/cache@v2
23-
with:
24-
path: ~/.npm
25-
key: ${{ runner.os }}-node-${{ hashFiles('**/yarn.lock') }}
26-
restore-keys: |
27-
${{ runner.os }}-node-
36+
cache: "yarn"
37+
cache-dependency-path: yarn.lock
2838
- run: yarn install
2939
- run: yarn check-links
3040

3141
check-style:
3242
runs-on: ubuntu-20.04
3343
steps:
34-
- uses: actions/checkout@v2
35-
- uses: actions/setup-node@v2
44+
- uses: actions/checkout@v3
45+
- uses: actions/setup-node@v3
3646
with:
3747
node-version: 14
38-
registry-url: https://registry.npmjs.org/
39-
- name: Cache dependencies
40-
uses: actions/cache@v2
41-
with:
42-
path: ~/.npm
43-
key: ${{ runner.os }}-node-${{ hashFiles('**/yarn.lock') }}
44-
restore-keys: |
45-
${{ runner.os }}-node-
48+
cache: "yarn"
49+
cache-dependency-path: yarn.lock
4650
- run: yarn install
4751
- run: yarn style

Diff for: .github/workflows/gh-pages-scraping.yml

+5-8
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ jobs:
1010
runs-on: ubuntu-20.04
1111

1212
steps:
13-
- uses: actions/checkout@v2
14-
- uses: actions/setup-node@v2
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-node@v3
1515
with:
1616
node-version: 14
17-
registry-url: https://registry.npmjs.org/
17+
cache: "yarn"
18+
cache-dependency-path: yarn.lock
1819
- name: Publish
1920
uses: netlify/actions/build@master
2021
env:
@@ -27,11 +28,7 @@ jobs:
2728
needs: build-deploy
2829
runs-on: ubuntu-20.04
2930
steps:
30-
- uses: actions/checkout@v2
31-
- uses: actions/setup-node@v2
32-
with:
33-
node-version: 14
34-
registry-url: https://registry.npmjs.org/
31+
- uses: actions/checkout@v3
3532
- name: Run docs-scraper
3633
env:
3734
HOST_URL: ${{ secrets.MEILISEARCH_HOST_URL }}

Diff for: .vuepress/config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ module.exports = {
358358
'img-lazy',
359359
// Because colors can not be set through the settings of the plugin
360360
// Change are done in .vuepress/styles/palette.styl
361-
'vuepress-plugin-element-tabs',
361+
'@bidoubiwa/vuepress-plugin-element-tabs',
362362
['vuepress-plugin-container', { type: 'note' }],
363363
[require('./config-path-checker')],
364364
[require('./custom-markdown-rules')],

Diff for: README.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If this happens to you and you think there has been some mistake, please let us
2424

2525
### Requirements
2626

27-
- Node version >= v10 and < v15
27+
- Node version >= v14 and <= v16
2828

2929
### Installing & Running
3030

Diff for: package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@
3131
"author": "tpayet",
3232
"license": "MIT",
3333
"dependencies": {
34+
"@bidoubiwa/vuepress-plugin-element-tabs": "^0.2.9",
3435
"vuepress": "^1.8.2",
3536
"vuepress-plugin-code-copy": "^1.0.6",
3637
"vuepress-plugin-container": "^2.1.5",
37-
"vuepress-plugin-element-tabs": "^0.2.8",
3838
"vuepress-plugin-img-lazy": "^1.0.4",
3939
"vuepress-plugin-meilisearch": "0.12.1",
4040
"vuepress-plugin-seo": "^0.1.4",
@@ -44,7 +44,7 @@
4444
"vuex": "^3.6.2"
4545
},
4646
"engines": {
47-
"node": ">=12 <15"
47+
"node": ">=12 <=16"
4848
},
4949
"resolutions": {
5050
"vuepress-plugin-check-md/check-md": "https://github.com/bidoubiwa/check-md#add_ignore_pattern"

0 commit comments

Comments
 (0)