Skip to content

Commit b50fb65

Browse files
Merge #815 #816
815: Update nodeJs requirements in readme and CI r=bidoubiwa a=bidoubiwa Fixes the node js compatibility in readme and make publishing use node 16 816: Update beta guide in contributing r=bidoubiwa a=bidoubiwa The beta guide was wrongly telling the user to create a specific formated branch which is not the one required. Co-authored-by: Charlotte Vermandel <[email protected]>
3 parents 3f9ccc6 + ff228ca + 589d49c commit b50fb65

File tree

3 files changed

+4
-6
lines changed

3 files changed

+4
-6
lines changed

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
- uses: actions/checkout@v3
1111
- uses: actions/setup-node@v3
1212
with:
13-
node-version: 12
13+
node-version: 16
1414
registry-url: https://registry.npmjs.org/
1515
- name: Check release validity
1616
run: sh .github/scripts/check-release.sh

CONTRIBUTING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,7 @@ Here are the steps to release a beta version of this package:
175175
git checkout -b bump-meilisearch-v*.*.*-beta
176176
```
177177

178-
- Change the version in `package.json` with `*.*.*-xxx-beta.0` and commit it to the `v*.*.*-beta` branch. None or multiple `-xxx`are valid. Examples:
179-
- `v*.*.*-my-feature-beta.0`
180-
- `v*.*.*-beta.0`
178+
- Change the version in [`package.json`](/package.json) and [`src/package-version`](/src/package-version.ts) with `*.*.*-xxx-beta.0` and commit it to the `v*.*.*-beta` branch.
181179

182180
- Go to the [GitHub interface for releasing](https://github.com/meilisearch/instant-meilisearch/releases): on this page, click on `Draft a new release`.
183181

@@ -194,7 +192,7 @@ GitHub Actions will be triggered and push the beta version to [npm](https://www.
194192
💡 If you need to release a new beta for the same version (i.e. `vX.X.X-beta.1`):
195193
- merge the change into `bump-meilisearch-v*.*.*`
196194
- rebase the `vX.X.X-beta.0` branch
197-
- change the version name in `package.json`
195+
- change the version name in [`package.json`](/package.json) and [`src/package-version`](/src/package-version.ts)
198196
- creata a pre-release via the GitHub interface
199197

200198
<hr>

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ This package only guarantees the compatibility with the [version v0.28.0 of Meil
257257

258258
**Node / NPM versions**:
259259

260-
- NodeJS >= 12.10 <= 14
260+
- NodeJS >= 12.10 <= 18
261261
- NPM >= 6.x
262262

263263
## 📜 API resources

0 commit comments

Comments
 (0)