Prepare release v8.1.0 (#2235)

ruflin · Nov 29, 2024 · 5e5f9b2 · 5e5f9b2
1 parent 5804288
commit 5e5f9b2
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,27 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/ruflin/Elastica/compare/8.0.0...8.x)
+## [Unreleased](https://github.com/ruflin/Elastica/compare/8.1.0...8.x)
 
 ### Backward Compatibility Breaks
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+## [8.1.0](https://github.com/ruflin/Elastica/compare/8.0.0...8.1.0)
 
 ### Added
 * Added support for the multi-match query type `bool_prefix` [#2220](https://github.com/ruflin/Elastica/pull/2220)
-* Supported PHP 8.4 [#2221](https://github.com/ruflin/Elastica/pull/2221)
+* Added support for PHP 8.4 [#2221](https://github.com/ruflin/Elastica/pull/2221)
 * Added support for custom key to IpRange and GeoDistance `addRange` using a common trait [#2227](https://github.com/ruflin/Elastica/pull/2227)
 * Added bucket sort aggregation [#2229](https://github.com/ruflin/Elastica/pull/2229)
 
-### Changed
-
-### Deprecated
-
-### Removed
-
 ### Fixed
 * Fixed Pipeline Processor handling to allow for multiple processors of the same type [#2218](https://github.com/ruflin/Elastica/pull/2218)
 
-### Security
-
 ## [8.0.0](https://github.com/ruflin/Elastica/compare/8.0.0-alpha1...8.0.0)
 
 This a major release with breaking changes.

diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Elastica: elasticsearch PHP Client
-==================================
+# Elastica: elasticsearch PHP Client
 
 [![Latest Stable Version](https://poser.pugx.org/ruflin/Elastica/v/stable.png)](https://packagist.org/packages/ruflin/elastica)
 [![Build Status](https://github.com/ruflin/elastica/workflows/Continuous%20integration/badge.svg?branch=master)](https://github.com/ruflin/Elastica/actions?query=workflow%3A%22Continuous%20integration%22%20branch%3Amaster)
@@ -10,40 +9,37 @@ Elastica: elasticsearch PHP Client
 [![Join the chat at https://gitter.im/ruflin/Elastica](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ruflin/Elastica?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 All documentation for Elastica can be found under [Elastica.io](http://Elastica.io/).
-If you have questions, don't hesitate to ask them on [Stack Overflow](http://stackoverflow.com/questions/tagged/elastica) and add the Tag "Elastica" or
-in our [Gitter](https://gitter.im/ruflin/Elastica) channel.
+If you have questions, don't hesitate to ask them on [Stack Overflow](http://stackoverflow.com/questions/tagged/elastica)
+and add the Tag "Elastica" or in our [Gitter](https://gitter.im/ruflin/Elastica) channel.
+
 All library issues should go to the [issue tracker from GitHub](https://github.com/ruflin/Elastica/issues).
 
+## Compatibility
 
-Compatibility
--------------
 This release is compatible with all Elasticsearch 8.0 releases and onwards.
 
 The testsuite is run against the most recent minor version of Elasticsearch, currently 8.8.0 and 8.9.0-SNAPSHOT
 
+## Contributing
 
-Contributing
-------------
 Contributions are always welcome.
 For details on how to contribute, check the [CONTRIBUTING](https://github.com/ruflin/Elastica/blob/master/CONTRIBUTING.md) file.
 
+## Versions & Dependencies
 
-Versions & Dependencies
-------------
 This project tries to follow Elasticsearch in terms of [End of Life](https://www.elastic.co/support/eol) and maintenance since 5.x.
 It is generally recommended to use the latest point release of the relevant branch.
 
-| Elastica branch                                       | ElasticSearch | elasticsearch-php | PHP            |
-| ----------------------------------------------------- | ------------- | ----------------- | -------------- |
-| [8.x](https://github.com/ruflin/Elastica/tree/8.x)    | 8.x           | ^8.4              | >=8.0 <8.4
-| [7.x](https://github.com/ruflin/Elastica/tree/7.x)    | 7.x           | ^7.0              | ^7.2 \|\| ^8.0 |
-| [6.x](https://github.com/ruflin/Elastica/tree/6.x)    | 6.x           | ^6.0              | ^7.0 \|\| ^8.0 |
+| Elastica branch                                    | ElasticSearch | elasticsearch-php | PHP            |
+|----------------------------------------------------|---------------|-------------------|----------------|
+| [8.x](https://github.com/ruflin/Elastica/tree/8.x) | 8.x           | ^8.4              | >=8.0 <8.4     |
+| [7.x](https://github.com/ruflin/Elastica/tree/7.x) | 7.x           | ^7.0              | ^7.2 \|\| ^8.0 |
+| [6.x](https://github.com/ruflin/Elastica/tree/6.x) | 6.x           | ^6.0              | ^7.0 \|\| ^8.0 |
 
 Unmaintained versions:
 
-| Elastica version                                      | ElasticSearch | elasticsearch-php | PHP            |
-| ----------------------------------------------------- | ------------- | ----------------- | -------------- |
-| [5.x](https://github.com/ruflin/Elastica/tree/5.x)    | 5.x           | ^5.0              | \>=5.6         |
-| [3.x](https://github.com/ruflin/Elastica/tree/3.x)    | 2.4.0         | no                | \>=5.4         |
-| [2.x](https://github.com/ruflin/Elastica/tree/2.x)    | 1.7.2         | no                | \>=5.3.3       |
-------------
+| Elastica version                                   | ElasticSearch | elasticsearch-php | PHP      |
+|----------------------------------------------------|---------------|-------------------|----------|
+| [5.x](https://github.com/ruflin/Elastica/tree/5.x) | 5.x           | ^5.0              | \>=5.6   |
+| [3.x](https://github.com/ruflin/Elastica/tree/3.x) | 2.4.0         | no                | \>=5.4   |
+| [2.x](https://github.com/ruflin/Elastica/tree/2.x) | 1.7.2         | no                | \>=5.3.3 |