From c5b71d8f5cab8fc376e6f28c12ae7b4a67919057 Mon Sep 17 00:00:00 2001 From: Andrew Date: Thu, 1 Mar 2018 04:20:21 -0800 Subject: [PATCH] Added breaking changes to readme [skip ci] --- CHANGELOG.md | 1 + README.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 0 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67b807b..de6a9da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ - Types are no longer supported. To upgrade models that use inheritance, upgrade your gem to `2.5.0`. Added `inheritance: true` to your `searchkick` method, and do a full reindex before upgrading. - Bumped default `limit` to 10,000 - The `_all` field is disabled by default in Elasticsearch 5. Use `searchkick _all: true` if you need it. +- An `ArgumentError` is raised instead of a warning when options are incompatible with the `body` option ## 2.5.1 [unreleased] diff --git a/README.md b/README.md index 2d5ee28..c306610 100644 --- a/README.md +++ b/README.md @@ -1854,6 +1854,18 @@ View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG. Important notes are listed below. +### 3.0.0 + +#### Breaking Changes + +- Removed support for Elasticsearch 2 +- Removed support for ActiveRecord < 4.2 and Mongoid < 5 +- Removed `reindex_async` method. `reindex` now defaults to mode specified by model. Use `reindex(mode: :async)` to force async reindex. +- Types are no longer supported. To upgrade models that use inheritance, upgrade your gem to `2.5.0`. Added `inheritance: true` to your `searchkick` method, and do a full reindex before upgrading. +- Bumped default `limit` to 10,000 +- The `_all` field is disabled by default in Elasticsearch 5. Use `searchkick _all: true` if you need it. +- An `ArgumentError` is raised instead of a warning when options are incompatible with the `body` option + ### 2.0.0 - Added support for `reindex` on associations -- libgit2 0.21.0