Skip to content

Commit

Permalink
Preparing for release, 2.3.0.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <dblock@amazon.com>
  • Loading branch information
dblock committed Apr 23, 2024
1 parent d3fb3c0 commit bcc85a8
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 25 deletions.
20 changes: 9 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [Unreleased]
## [2.3.0]

### Added

- Added a GitHub workflow for verifying CHANGELOG ([#92](https://github.com/opensearch-project/opensearch-php/pull/92))
- Added class docs generator ([#96](https://github.com/opensearch-project/opensearch-php/pull/96))
- Added support for Amazon OpenSearch Serverless SigV4 signing ([#119](https://github.com/opensearch-project/opensearch-php/pull/119))
- Added `includePortInHostHeader` option to `ClientBuilder::fromConfig` ([#118](https://github.com/opensearch-project/opensearch-php/pull/118))
- Added the `RefreshSearchAnalyzers` endpoint ([[#152](https://github.com/opensearch-project/opensearch-php/issues/152))
- Added the `RefreshSearchAnalyzers` endpoint ([#152](https://github.com/opensearch-project/opensearch-php/issues/152))
- Added support for `format` parameter to specify the sql response format ([#161](https://github.com/opensearch-project/opensearch-php/pull/161))
- Added ml-commons model, model group and connector APIs ([#170](https://github.com/opensearch-project/opensearch-php/pull/170))
- Added support for sending raw JSON requests ([#171](https://github.com/opensearch-project/opensearch-php/pull/177))
Expand All @@ -20,12 +21,6 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added support for OpenSearch 2.12 and 2.13 ([#180](https://github.com/opensearch-project/opensearch-php/pull/180))
- Added release automation to publish to packagist ([#183](https://github.com/opensearch-project/opensearch-php/pull/183))

### Changed

### Deprecated

### Removed

### Fixed

- Fixed backport workflow when tag is applied before closing PR ([#131](https://github.com/opensearch-project/opensearch-php/pull/131))
Expand All @@ -34,6 +29,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Fixed basic authentication being overridden by connection params in `ClientBuilder` ([#160](https://github.com/opensearch-project/opensearch-php/pull/160))
- Fixed PHP warning in `Connection::tryDeserializeError()` for some error responses ([#167](https://github.com/opensearch-project/opensearch-php/issues/167))

### Security

[Unreleased]: https://github.com/opensearch-project/opensearch-php/compare/2.0...HEAD
[2.3.0]: https://github.com/opensearch-project/opensearch-php/compare/2.2.0...2.3.0
[2.2.0]: https://github.com/opensearch-project/opensearch-php/compare/2.1.0...2.2.0
[2.1.0]: https://github.com/opensearch-project/opensearch-php/compare/2.0.3...2.1.0
[2.0.3]: https://github.com/opensearch-project/opensearch-php/compare/2.0.2...2.0.3
[2.0.2]: https://github.com/opensearch-project/opensearch-php/compare/2.0.1...2.0.2
[2.0.1]: https://github.com/opensearch-project/opensearch-php/compare/2.0.0...2.0.1
2 changes: 1 addition & 1 deletion COMPATIBILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The below matrix shows the compatibility of the [`opensearch-project/opensearch-
| Client Version | OpenSearch Version |
| --- | --- |
| 1.0.0 | 1.0.0-2.1.0 |
| 2.0.0 | 1.0.0-2.1.0 |
| 2.x.x | 1.0.0-2.1.0 |

## Upgrading

Expand Down
26 changes: 14 additions & 12 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
- [Plugin Branching](#plugin-branching)
- [Versioning](#versioning)
- [Feature Branches](#feature-branches)
- [Backporting](#backporting)
- [Release Labels](#release-labels)
- [Releasing](#releasing)
- [Backporting](#backporting)

## Overview

Expand Down Expand Up @@ -45,16 +45,6 @@ Versions are incremented as soon as development starts on a given version to avo

Do not creating branches in the upstream repo, use your fork, for the exception of long lasting feature branches that require active collaboration from multiple developers. Name feature branches `feature/<thing>`. Once the work is merged to `main`, please make sure to delete the feature branch.

## Release Labels

Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v2.0.0`, as well as `patch` and `backport`. Use release labels to target an issue or a PR for a given release. See [MAINTAINERS](MAINTAINERS.md#triage-open-issues) for more information on triaging issues.

## Releasing

The release process is standard across repositories in this org and is run by a release manager volunteering from amongst [MAINTAINERS](MAINTAINERS.md).

Push a tag to this repository aganist the right commit. This triggers [release.yml](.github/workflows/release.yml) workflow which is responsible to get approval from the maintainers in the form of comments on the GitHub issue, release the client to packagist using manual webhook and finally publishing a release on the GitHub.

## Backporting

This project follows [semantic versioning](https://semver.org/spec/v2.0.0.html). Backwards-incompatible changes always result in a new major version and will __never__ be backported. Small improvements and features will be backported to a new minor version (e.g. `1.1`). Security fixes will be backported to a new patch version (e.g. `1.0.1`).
Expand Down Expand Up @@ -86,4 +76,16 @@ git cherry-pick <commit-id> -s
git push origin backport-pr-xyz-1.x
```

5. Create a pull request for the change.
5. Create a pull request for the change.

## Release Labels

Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v2.0.0`, as well as `patch` and `backport`. Use release labels to target an issue or a PR for a given release. See [MAINTAINERS](MAINTAINERS.md#triage-open-issues) for more information on triaging issues.

## Releasing

The release process is standard across repositories in this org and is run by a release manager volunteering from amongst [MAINTAINERS](MAINTAINERS.md).

1. Update CHANGELOG with the version number, and make a pull request (e.g. [#184](https://github.com/opensearch-project/opensearch-php/pull/184)).
2. Push a tag to this repository against the right commit. This triggers the [release.yml](.github/workflows/release.yml) workflow which is responsible to get approval from the maintainers in the form of comments on the GitHub issue, release the client to [packagist](https://packagist.org/packages/opensearch-project/opensearch-php) using a manual webhook, and finally publishing a [release on GitHub](https://github.com/opensearch-project/opensearch-php/releases).
3. Increment the version in [Client.php](https://github.com/opensearch-project/opensearch-php/blob/main/src/OpenSearch/Client.php#L55) for the next developer iteration, add an `[Unreleased]` section to [CHANGELOG](CHANGELOG.md), and make a pull request.
2 changes: 1 addition & 1 deletion src/OpenSearch/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class Client
/**
* @deprecated since version is pulled from InstalledVersions::getVersion('opensearch-project/opensearch-php')
*/
public const VERSION = '2.1.0';
public const VERSION = '2.3.0';

/**
* @var Transport
Expand Down

0 comments on commit bcc85a8

Please sign in to comment.