Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/release-draft-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,5 @@ template: |
no-changes-template: 'Changes are coming soon 😎'
sort-direction: 'ascending'
replacers:
- search: '/(?:and )?@bors(?:\[bot\])?,?/g'
replace: ''
- search: '/(?:and )?@meili-bot,?/g'
replace: ''
- search: '/(?:and )?@meili-bors[bot],?/g'
replace: ''
4 changes: 1 addition & 3 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ name: Tests
on:
pull_request:
push:
# trying and staging branches are for Bors config
branches:
- trying
- staging
- main
merge_group:

jobs:
integration-tests:
Expand Down
6 changes: 0 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,19 +128,13 @@ Some notes on GitHub PRs:

- [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
- All PRs must be reviewed and approved by at least one maintainer.
- The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-rails/releases/).

## Release Process (for the internal team only)

Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/).

### Automation to Rebase and Merge the PRs <!-- omit in toc -->

This project integrates a bot that helps us manage pull requests merging.<br>
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._

### Automated Changelogs <!-- omit in toc -->

This project integrates a tool to create automated changelogs.<br>
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
<img src="https://codecov.io/gh/meilisearch/meilisearch-rails/branch/main/graph/badge.svg?token=9J7LRP11IR"/>
</a>
<a href="https://github.com/meilisearch/meilisearch-rails/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
<a href="https://ms-bors.herokuapp.com/repositories/68"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
</p>

<p align="center">⚡ The Meilisearch integration for Ruby on Rails 💎</p>
Expand Down Expand Up @@ -113,7 +112,7 @@ bin/rails meilisearch:install

The gem is compatible with [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord), [Mongoid](https://github.com/mongoid/mongoid) and [Sequel](https://github.com/jeremyevans/sequel).

⚠️ Note that even if you want to use all the default options, you must declare an empty `meilisearch` block in your model.
⚠️ Note that even if you want to use all the default options, you must declare an empty `meilisearch` block in your model.

#### Add documents <!-- omit in toc -->

Expand Down Expand Up @@ -348,7 +347,7 @@ An enumerable `FederatedSearchResult` is returned, which can be iterated through


<ul>
<!-- Attack on Titan appears first even though it was specified second,
<!-- Attack on Titan appears first even though it was specified second,
it's ranked higher because it's a closer match -->
<li>Attack on Titan</li>
<li>Harry Potter and the Philosopher's Stone</li>
Expand Down Expand Up @@ -387,7 +386,7 @@ results = Meilisearch::Rails.federated_search(

### Loading records <!-- omit in toc -->

Records are loaded when the `:scope` option is passed (may be a model or a relation),
Records are loaded when the `:scope` option is passed (may be a model or a relation),
or when a hash query is used with models as keys:

```ruby
Expand Down Expand Up @@ -601,7 +600,7 @@ Meilisearch::Rails.deactivate! # all the following HTTP calls will be dismissed.

Meilisearch::Rails.deactivate! do
# every Meilisearch call here will be dismissed, no error will be raised.
# after the block, Meilisearch state will be active.
# after the block, Meilisearch state will be active.
end
```

Expand Down Expand Up @@ -687,7 +686,7 @@ class Book < ActiveRecord::Base
end
```

You can also set the `primary_key` as a method, this method will be evaluated in runtime, and its return
You can also set the `primary_key` as a method, this method will be evaluated in runtime, and its return
will be used as the reference to the document when Meilisearch needs it.

```rb
Expand Down