meilisearch - npm Package Compare versions

Comparing version 0.24.0-beta.0 to 0.24.0-beta.1

CONTRIBUTING.md

@@ -119,4 +119,37 @@ # Contributing
 
+#### Release a `beta` Version
+
+Here are the steps to release a beta version of this package:
+
+- Create a new branch originating the branch containing the "beta" changes. For example, if during the MeiliSearch pre-release, create a branch originating `bump-meilisearch-v*.*.*`.<br>
+`vX.X.X` is the next version of the package, NOT the version of MeiliSearch!
+
+```bash
+git checkout bump-meilisearch-v*.*.*
+git pull origin bump-meilisearch-v*.*.*
+git checkout -b vX.X.X-beta.0
+```
+
+- Change the version in `package.json` by `vX.X.X-beta.0` and commit it to the `vX.X.X-beta.0` branch
+
+- Go to the [GitHub interface for releasing](https://github.com/meilisearch/meilisearch-js/releases): on this page, click on `Draft a new release`.
+
+- Create a GitHub pre-release:
+  - Fill the description with the detailed changelogs
+  - Fill the title with `vX.X.X-beta.0`
+  - Fill the tag with `vX.X.X-beta.0`
+  - ⚠️ Select the `vX.X.X-beta.0` branch and NOT `main`
+  - ⚠️ Click on the "This is a pre-release" checkbox
+  - Click on "Publish release"
+
+GitHub Actions will be triggered and push the beta version to [npm](https://www.npmjs.com/package/meilisearch).
+
+💡 If you need to release a new beta for the same version (i.e. `vX.X.X-beta.1`):
+- merge the change into `bump-meilisearch-v*.*.*`
+- rebase the `vX.X.X-beta.0` branch
+- change the version name in `package.json`
+- creata a pre-release via the GitHub interface
+
 <hr>
 
 Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️

dist/types/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for meilisearch 0.24.0-beta.0
+// Type definitions for meilisearch 0.24.0-beta.1
 // Project: https://github.com/meilisearch/meilisearch-js
@@ -3,0 +3,0 @@ // Definitions by: cvermand <[e-mail]> <https://github.com/meilisearch>

dist/types/lib/meilisearch.d.ts

@@ -133,3 +133,3 @@ import { Index } from './indexes';
      */
-    getKeys(): Promise<Key[]>;
+    getKeys(): Promise<Result<Key[]>>;
     /**
@@ -136,0 +136,0 @@ * Get one API key

package.json

 {
   "name": "meilisearch",
-  "version": "0.24.0-beta.0",
+  "version": "0.24.0-beta.1",
   "description": "The MeiliSearch JS client for Node.js and the browser.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -600,3 +600,3 @@ <p align="center">
 
-`client.getKeys(): Promise<Keys>`
+`client.getKeys(): Promise<Result<Key[]>>`
 
@@ -603,0 +603,0 @@ - [Get one key](https://docs.meilisearch.com/reference/api/keys.html#get-one-key):

src/lib/meilisearch.ts

@@ -237,6 +237,5 @@ /*
    */
-  // FIXME: should be Result<Key[]>>
-  async getKeys(): Promise<Key[]> {
+  async getKeys(): Promise<Result<Key[]>> {
     const url = `keys`
-    return await this.httpRequest.get<Key[]>(url)
+    return await this.httpRequest.get<Result<Key[]>>(url)
   }
@@ -243,0 +242,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

391671

increased by0.35%

Worsened metrics

Lines of code

7886

decreased by-0.04%

No dependency changes