Skip to content

Commit

Permalink
Merge pull request #113 from 10up/release/2.3.1
Browse files Browse the repository at this point in the history
[Release] Version 2.3.1
  • Loading branch information
felipeelia authored Dec 11, 2024
2 parents c651524 + bb09b9b commit 2a7b388
Show file tree
Hide file tree
Showing 8 changed files with 67 additions and 14 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ All notable changes to this project will be documented in this file, per [the Ke
### Security
-->

## [2.3.1] - 2024-12-11

### Added
- ElasticPress as a plugin dependency. Props [@jeffpaul](https://github.com/jeffpaul) via [#104](https://github.com/10up/ElasticPress/pull/104).

### Changed
- Bumped actions/upload-artifact from v3 to v4. Props [@iamdharmesh](https://github.com/iamdharmesh) via [#106](https://github.com/10up/ElasticPress/pull/106).
- Update versions of GitHub Actions, composer, and node packages. Props [@felipeelia](https://github.com/felipeelia) via [#110](https://github.com/10up/ElasticPress/pull/110) and [#111](https://github.com/10up/ElasticPress/pull/111).

## Fixed
- Textdomain in the Users feature. Props [@burhandodhy](https://github.com/burhandodhy) via [#114](https://github.com/10up/ElasticPress/pull/114).

## [2.3.0] - 2024-03-04

This version introduces the new *External Content* feature. Check [our blog post](https://www.elasticpress.io/blog/2024/03/pew-research-center-external-files-as-a-source-for-your-search) for more info.
Expand Down Expand Up @@ -115,6 +127,7 @@ This version introduces the new *External Content* feature. Check [our blog post
- Initial plugin release.

[Unreleased]: https://github.com/10up/ElasticPressLabs/compare/trunk...develop
[2.3.1]: https://github.com/10up/ElasticPressLabs/compare/2.3.0...2.3.1
[2.3.0]: https://github.com/10up/ElasticPressLabs/compare/2.2.0...2.3.0
[2.2.0]: https://github.com/10up/ElasticPressLabs/compare/2.1.1...2.2.0
[2.1.1]: https://github.com/10up/ElasticPressLabs/compare/2.1.0...2.1.1
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ The `develop` branch is the development branch which means it contains the next
## Release instructions

1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
1. Version bump: Bump the version number in `elasticpresslabs.php`, `/languages/ElasticPressLabs.pot`, `package-lock.json`, `package.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released. In `elasticpresslabs.php` update both the plugin "Version:" property and the plugin `ELASTICPRESS_LABS_VERSION` constant.
1. Version bump: Bump the version number in `elasticpresslabs.php`, `/languages/elasticpress-labs.pot`, `package-lock.json`, `package.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released. In `elasticpresslabs.php` update both the plugin "Version:" property and the plugin `ELASTICPRESS_LABS_VERSION` constant.
1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`, ensuring to link the [X.Y.Z] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/10up/ElasticPressLabs/compare/X.Y.Z-1...X.Y.Z).
1. Props: Update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
1. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
1. POT file: Run `wp i18n make-pot . languages/ElasticPressLabs.pot` and commit the file. In case of errors, try to disable Xdebug (see [#3079](https://github.com/10up/ElasticPress/pull/3079#issuecomment-1291028290).)
1. POT file: Run `wp i18n make-pot . languages/elasticpress-labs.pot` and commit the file. In case of errors, try to disable Xdebug (see [#3079](https://github.com/10up/ElasticPress/pull/3079#issuecomment-1291028290).)
1. Release date: Double check the release date in both changelog files.
1. Merge: Merge the release branch/PR into `develop`, then make a non-fast-forward merge from `develop` into `trunk` (`git checkout trunk && git merge --no-ff develop`). `trunk` contains the stable development version.
1. Test: While still on the `trunk` branch, test for functionality locally.
Expand All @@ -49,12 +49,12 @@ The `develop` branch is the development branch which means it contains the next
There may be cases where we have an urgent/important fix that ideally gets into a release quickly without any other changes (e.g., a "hotfix") so as to reduce (1) the amount or testing before being confident in the release and (2) to reduce the chance of unintended side effects from the extraneous non-urgent/important changes. In cases where code has previously been merged into `develop` but that ideally is not part of a hotfix, the normal release instructions above will not suffice as they would release all code merged to `develop` alongside the intended urgent/important "hotfix" change(s). In case of needing to release a "hotfix" the following are the recommended steps to take.

1. Branch: Starting from `trunk`, cut a hotfix release branch named `hotfix/X.Y.Z` for your hotfix change(s).
1. Version bump: Bump the version number in `elasticpresslabs.php`, `/languages/ElasticPressLabs.pot`, `package-lock.json`, `package.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released. In `elasticpresslabs.php` update both the plugin "Version:" property and the plugin `ELASTICPRESS_LABS_VERSION` constant.
1. Version bump: Bump the version number in `elasticpresslabs.php`, `/languages/elasticpress-labs.pot`, `package-lock.json`, `package.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released. In `elasticpresslabs.php` update both the plugin "Version:" property and the plugin `ELASTICPRESS_LABS_VERSION` constant.
1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`, ensuring to link the [X.Y.Z] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/10up/ElasticPressLabs/compare/X.Y.Z-1...X.Y.Z).
1. Props: Update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
1. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
1. POT file: Run `wp i18n make-pot . lang/elasticpress.pot` and commit the file.
1. POT file: Run `wp i18n make-pot . lang/elasticpress-labs.pot` and commit the file.
1. Release date: Double check the release date in both changelog files.
1. Merge: Merge the release branch/PR into `trunk`. `trunk` contains the stable development version.
1. Test: While still on the `trunk` branch, test for functionality locally.
Expand Down
1 change: 1 addition & 0 deletions CREDITS.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Thank you to all the people who have already contributed to this repository via
[Burhan Nasir (@burhandodhy)](https://github.com/burhandodhy),
[Mohammed Razzaq (@MARQAS)](https://github.com/MARQAS),
[Eric Caron (@ecaron)](https://github.com/ecaron),
[Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh),
and
[Felipe Elia (@felipeelia)](https://github.com/felipeelia).

Expand Down
4 changes: 2 additions & 2 deletions elasticpresslabs.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Plugin Name: ElasticPress Labs
* Plugin URI: https://github.com/10up/ElasticPressLabs
* Description: A developer focused interface to commonly ElasticPress plugin issues.
* Version: 2.3.0
* Version: 2.3.1
* Requires Plugins: elasticpress
* Requires at least: 5.6
* Requires PHP: 7.0
Expand All @@ -19,7 +19,7 @@
*/

// Useful global constants.
define( 'ELASTICPRESS_LABS_VERSION', '2.3.0' );
define( 'ELASTICPRESS_LABS_VERSION', '2.3.1' );
define( 'ELASTICPRESS_LABS_URL', plugin_dir_url( __FILE__ ) );
define( 'ELASTICPRESS_LABS_PATH', plugin_dir_path( __FILE__ ) );
define( 'ELASTICPRESS_LABS_INC', ELASTICPRESS_LABS_PATH . 'includes/' );
Expand Down
31 changes: 28 additions & 3 deletions languages/ElasticPressLabs.pot → languages/elasticpress-labs.pot
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
# This file is distributed under the GPL v2 or later.
msgid ""
msgstr ""
"Project-Id-Version: ElasticPress Labs 2.3.0\n"
"Project-Id-Version: ElasticPress Labs 2.3.1\n"
"Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/elasticpress-labs\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"POT-Creation-Date: 2024-03-04T12:48:18+00:00\n"
"POT-Creation-Date: 2024-12-11T17:01:02+00:00\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"X-Generator: WP-CLI 2.8.1\n"
"X-Domain: elasticpress-labs\n"
Expand All @@ -35,7 +35,7 @@ msgstr ""
msgid "https://10up.com"
msgstr ""

#: elasticpresslabs.php:35
#: elasticpresslabs.php:36
msgid "Error: Please run $ composer install in the ElasticPress Labs plugin directory."
msgstr ""

Expand Down Expand Up @@ -199,6 +199,27 @@ msgstr ""
msgid "Changes in this feature will be reflected only on the next page reload or expiration of any front-end caches."
msgstr ""

#: includes/classes/Feature/Users.php:25
#: includes/classes/Indexable/User/User.php:44
msgid "Users"
msgstr ""

#: includes/classes/Feature/Users.php:27
msgid "Improve user search relevancy and query performance."
msgstr ""

#: includes/classes/Feature/Users.php:29
msgid "https://elasticpress.zendesk.com/hc/en-us/articles/360050447492-Configuring-ElasticPress-via-the-Plugin-Dashboard#users"
msgstr ""

#: includes/classes/Feature/Users.php:61
msgid "This feature will empower your website to overcome traditional WordPress user search and query limitations that can present themselves at scale."
msgstr ""

#: includes/classes/Feature/Users.php:62
msgid "Be aware that storing user data may bound you to certain legal obligations depending on your local government regulations."
msgstr ""

#: includes/classes/Feature/WooCommerceSubscriptionSearch.php:33
msgid "WooCommerce Admin Subscription Search"
msgstr ""
Expand All @@ -219,6 +240,10 @@ msgstr ""
msgid "This feature requires the WooCommerce and Protected Content features to be enabled."
msgstr ""

#: includes/classes/Indexable/User/User.php:45
msgid "User"
msgstr ""

#: includes/functions/core.php:243
msgid "ElasticPress Labs needs ElasticPress to work."
msgstr ""
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "elasticpress-labs",
"version": "2.3.0",
"version": "2.3.1",
"description": "ElasticPress Labs",
"author": {
"name": "10up",
Expand Down
18 changes: 16 additions & 2 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Contributors: 10up
Tags: Elasticsearch, ElasticPress, search, boolean, Co-Authors Plus
Requires at least: 5.6
Tested up to: 6.4
Stable tag: 2.3.0
Tested up to: 6.7
Stable tag: 2.3.1
Requires PHP: 7.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Expand All @@ -28,6 +28,20 @@ This plugin provides a simple interface to enable and disable features.

== Changelog ==

= 2.3.1 - 2024-12-11 =

__Added:__

* ElasticPress as a plugin dependency. Props [@jeffpaul](https://github.com/jeffpaul).

__Changed:__

* Bumped actions/upload-artifact from v3 to v4. Props [@iamdharmesh](https://github.com/iamdharmesh).
* Update versions of GitHub Actions, composer, and node packages. Props [@felipeelia](https://github.com/felipeelia).

__Fixed:__

* Textdomain in the Users feature. Props [@burhandodhy](https://github.com/burhandodhy).

= 2.3.0 - 2024-03-04 =

Expand Down

0 comments on commit 2a7b388

Please sign in to comment.