Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update version for the next release (v0.47.0) #1797

Merged
merged 2 commits into from
Dec 23, 2024
Merged

Conversation

meili-bot
Copy link
Contributor

@meili-bot meili-bot commented Dec 10, 2024

This PR is auto-generated.

The automated script updates the version of meilisearch-js to a new version: "v0.47.0"

CHANGELOGS 👇

This version introduces features released on Meilisearch v1.12.0 🎉

Check out the Meilisearch v1.12.0 changelog for more information.

🚀 Enhancements

Introducing new methods to get one or several batches, respectively getBatch() and getBatches().

// fetch one batch using batch UID
const batch = await client.getBatch(123)

// fetch all batches
const batches = await client.getBatches()

The getTasks() methods now accept a reverse parameter to retrieve tasks in reverse chronological order.

const tasks = await client.getTasks({ reverse: true });

Index settings now allow disabling prefix search and facet search. They're both enabled by default. The SDK now comes with dedicated methods to configure these settings.

// disable prefix search
await client.index('myIndex').updatePrefixSearch('disabled')
// reset prefix search settings
await client.index('myIndex').resetPrefixSearch()

// disable facet search
await client.index('myIndex').updateFacetSearch(false)
// reset facet search settings
await client.index('myIndex').resetFacetSearch()

The _matchesPosition array now contains an indices array the text was matched in an array.

When searching for fantasy in a document that has a searchable genre field with the value genre: ["fantasy", "adventure"], the matches position will be as follow:

{
  genre: [{ start: 0, length: 7, indices: [0] }]
}

Which means:

  • There was a single match in the genre array (array length == 1)
  • The match started as position 0 (the first character, "f")
  • The match has a length of 7 (the entire "fantasy" word)
  • The match was in the first item of the array (indices == [0])

⚙️ Maintenance/misc

Thanks again to @/irevoire, @/Barabasbalazs, @/irevoire, @/curquiza, and @/Strift. 🎉

@meili-bot meili-bot added the skip-changelog The PR will not appear in the release changelogs label Dec 10, 2024
Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.81%. Comparing base (756d856) to head (402163f).
Report is 80 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1797   +/-   ##
=======================================
  Coverage   97.81%   97.81%           
=======================================
  Files          17       17           
  Lines        1465     1465           
  Branches      307      307           
=======================================
  Hits         1433     1433           
  Misses         32       32           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Strift Strift self-assigned this Dec 11, 2024
@Strift Strift requested review from curquiza and mdubus December 11, 2024 08:23
@Strift
Copy link
Collaborator

Strift commented Dec 11, 2024

Hey @mdubus @curquiza, I'm not sure who usually handles reviews for the changelogs so I tagged you both. 😬

@curquiza curquiza removed the request for review from mdubus December 11, 2024 08:46
@curquiza
Copy link
Member

curquiza commented Dec 11, 2024

@Strift no need to tag Morgane here, only for coding PR 😊

Thank you for the changelog!

Some points

  • Can you add missing sentence at the beginning saying this version is compatible with meilisearch v1.12? (check examples in other release specific to Meilisearch releases)
  • Also, you did not put the already existing content of the draft of the release
  • I think it's more useful for users to see how to use batch methods (like you did for getTasks) rather to see the batch object (not everyone uses typescript)
Capture d’écran 2024-12-11 à 09 52 00

Also, thank you so much for all the details, but next time you can of course go shorter 😉 since our time is limited, the purpose is not to spend 15-30min on it. 5-10min is wayyy enough, you can be really quick. Focus on examples with library, don't explain the behavior of meilisearch, or the details of the typescript object. For any Meilisearch behavior, redirect to the changelogs

@Strift
Copy link
Collaborator

Strift commented Dec 11, 2024

Hey @curquiza, thanks for the review.

Also, you did not put the already existing content of the draft of the release

Where can I find this please?

@curquiza
Copy link
Member

@Strift
Copy link
Collaborator

Strift commented Dec 12, 2024

I don't understand what you're expecting of me.

On the link you provided, I can only see the content for releases v0.46.1 and earlier, but nothing related to v0.47. Should I see something else?

What should I include in the v0.47 release notes?

Screenshot 2024-12-12 at 11 10 00

@curquiza
Copy link
Member

curquiza commented Dec 12, 2024

On the link you provided, I can only see the content for releases v0.46.1 and earlier, but nothing related to v0.47. Should I see something else?

You can only see v0.46.1, but it's a draft release, not an actual release (only you and maintainers can see it).
The automated release drafter put 0.46.1 and not 0.47.0 because so far, no PR has been released with breaking changes, so only the patch (3rd number) increased.

What should I include in the v0.47 release notes?

Yes, I need to be able to only copy/paste what you wrote in this comment during D-day (23rd December), without thinking more, to save time (it's a really busy day)

@Strift
Copy link
Collaborator

Strift commented Dec 16, 2024

Okay, thanks for the explanation. I added the content of the draft release to the PR.

Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfecto
⚠️ to merge next Monday only

Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bors merge

Copy link
Contributor

meili-bors bot commented Dec 23, 2024

@meili-bot meili-bot merged commit eb60101 into main Dec 23, 2024
7 checks passed
@meili-bot meili-bot deleted the meili-bot/bump-version branch December 23, 2024 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants