Skip to content

Commit 480142a

Browse files
bors[bot]bidoubiwa
andauthored
Merge #155
155: Remove guaranteed compatibility with versions to 10> and <15 r=bidoubiwa a=bidoubiwa fixes #154 needs `tests` to be removed from mandatory tests in settings @curquiza Since the builded package can be used (without guarantee) in other node versions, we should not make it mandatory to use the right node version. It is at the discretion of the user. It is how most libraries handle node support. The use of `engines` in packages json limits the possibility to install the package in a specific node environment (see [issue](meilisearch/documentation#963 (comment))). Whereas typically a package that is bundled and transpiled should be as compatible as possible with all js environments. But, the packages we use in development are not. This is why we add it in the CONTRIBUTING guide Co-authored-by: Charlotte Vermandel <[email protected]> Co-authored-by: cvermand <[email protected]>
2 parents 20b9bf7 + 154c19a commit 480142a

File tree

3 files changed

+26
-7
lines changed

3 files changed

+26
-7
lines changed

.github/workflows/tests.yml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,22 @@ on:
1111

1212
jobs:
1313
tests:
14-
name: tests
1514
runs-on: ubuntu-latest
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
node: [ '12', '14' ]
19+
name: Tests (Node.js ${{ matrix.node }})
1620
steps:
17-
- uses: actions/checkout@v2
18-
- name: Install dependencies
19-
run: yarn install
20-
- name: Run tests
21-
run: yarn run test
21+
- uses: actions/checkout@v2
22+
- name: Setup node
23+
uses: actions/setup-node@v1
24+
with:
25+
node-version: ${{ matrix.node }}
26+
- name: Install dependencies
27+
run: yarn install
28+
- name: Run tests
29+
run: yarn run test
2230

2331
linter:
2432
name: linter-check

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
2626

2727
## Development Workflow
2828

29+
### Requirements <!-- omit in TOC -->
30+
31+
To run this project, you will need:
32+
33+
- Node.js >= v12 and node < 15
34+
- Yarn
35+
2936
### Setup <!-- omit in TOC -->
3037

3138
```bash

bors.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1-
status = ['tests', 'linter-check']
1+
status = [
2+
'linter-check',
3+
'Tests (Node.js 12)',
4+
'Tests (Node.js 14)'
5+
]
26
# 1 hour timeout
37
timeout-sec = 3600

0 commit comments

Comments
 (0)