From f1b6ced71bd7c52952c5d5be0d6d110c97296954 Mon Sep 17 00:00:00 2001 From: dblock Date: Thu, 15 Aug 2024 12:00:13 -0400 Subject: [PATCH 1/3] Prepare for release, 2.7.0. Signed-off-by: dblock --- .github/workflows/unified-release.yml | 2 +- CHANGELOG.md | 2 +- RELEASING.md | 11 ++++++----- benchmarks/poetry.lock | 2 +- opensearchpy/_version.py | 2 +- samples/poetry.lock | 2 +- 6 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/workflows/unified-release.yml b/.github/workflows/unified-release.yml index 3fce519d3..468c74a14 100644 --- a/.github/workflows/unified-release.yml +++ b/.github/workflows/unified-release.yml @@ -9,7 +9,7 @@ jobs: strategy: fail-fast: false matrix: - stack_version: ['2.6.0'] + stack_version: ["2.7.0"] steps: - name: Checkout diff --git a/CHANGELOG.md b/CHANGELOG.md index 39f10e009..a16e2f54b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # CHANGELOG Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -## [Unreleased] +## [2.7.0] ### Added - Added support for the `multi_terms` bucket aggregation ([#797](https://github.com/opensearch-project/opensearch-py/pull/797)) ### Changed diff --git a/RELEASING.md b/RELEASING.md index fdf80f16d..e9212bb5a 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -33,8 +33,9 @@ Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v The release process is standard across repositories in this org and is run by a release manager volunteering from amongst [maintainers](MAINTAINERS.md). -1. Create a tag, e.g. v2.1.0, and push it to the GitHub repo. -1. The [release-drafter.yml](.github/workflows/release-drafter.yml) will be automatically kicked off and a draft release will be created. -1. This draft release triggers the [jenkins release workflow](https://build.ci.opensearch.org/job/opensearch-py-release/) as a result of which opensearch-py client is released on [PyPi](https://pypi.org/project/opensearch-py/). -1. Once the above release workflow is successful, the drafted release on GitHub is published automatically. -1. Add an "Unreleased" section to CHANGELOG, and increment version to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/593). \ No newline at end of file +1. Update the version in [CHANGELOG](CHANGELOG.md), [_version.py](opensearchpy/_version.py) and [unified-release.yml](.github/workflows/unified-release.yml), make a pull request and have it merged. See [example](https://github.com/opensearch-project/opensearch-py/pull/799). +2. Create a tag, e.g. v2.1.0, and push it to the GitHub repo. +3. The [release-drafter.yml](.github/workflows/release-drafter.yml) will be automatically kicked off and a draft release will be created. +4. This draft release triggers the [jenkins release workflow](https://build.ci.opensearch.org/job/opensearch-py-release/) as a result of which opensearch-py client is released on [PyPi](https://pypi.org/project/opensearch-py/). +5. Once the above release workflow is successful, the drafted release on GitHub is published automatically. +6. Add an "Unreleased" section to CHANGELOG, and increment version in [_version.py](opensearchpy/_version.py) to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/593). \ No newline at end of file diff --git a/benchmarks/poetry.lock b/benchmarks/poetry.lock index 230a03426..1660a6281 100644 --- a/benchmarks/poetry.lock +++ b/benchmarks/poetry.lock @@ -505,7 +505,7 @@ files = [ [[package]] name = "opensearch-py" -version = "2.6.0" +version = "2.7.0" description = "Python client for OpenSearch" optional = false python-versions = ">=3.8, <4" diff --git a/opensearchpy/_version.py b/opensearchpy/_version.py index 1bc96b453..845089f5b 100644 --- a/opensearchpy/_version.py +++ b/opensearchpy/_version.py @@ -24,4 +24,4 @@ # specific language governing permissions and limitations # under the License. -__versionstr__: str = "2.6.0" +__versionstr__: str = "2.7.0" diff --git a/samples/poetry.lock b/samples/poetry.lock index 09012d591..013efde69 100644 --- a/samples/poetry.lock +++ b/samples/poetry.lock @@ -522,7 +522,7 @@ files = [ [[package]] name = "opensearch-py" -version = "2.6.0" +version = "2.7.0" description = "Python client for OpenSearch" optional = false python-versions = ">=3.8, <4" From 8cb32f7f50d550defd57be36e340a9282e7358c8 Mon Sep 17 00:00:00 2001 From: dblock Date: Mon, 19 Aug 2024 18:57:05 -0400 Subject: [PATCH 2/3] Remove references to Jenkins. Signed-off-by: dblock --- RELEASING.md | 7 +++---- jenkins/release.JenkinsFile | 13 ------------- test_opensearchpy/run_tests.py | 2 +- 3 files changed, 4 insertions(+), 18 deletions(-) delete mode 100644 jenkins/release.JenkinsFile diff --git a/RELEASING.md b/RELEASING.md index e9212bb5a..fee20a8e7 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -35,7 +35,6 @@ The release process is standard across repositories in this org and is run by a 1. Update the version in [CHANGELOG](CHANGELOG.md), [_version.py](opensearchpy/_version.py) and [unified-release.yml](.github/workflows/unified-release.yml), make a pull request and have it merged. See [example](https://github.com/opensearch-project/opensearch-py/pull/799). 2. Create a tag, e.g. v2.1.0, and push it to the GitHub repo. -3. The [release-drafter.yml](.github/workflows/release-drafter.yml) will be automatically kicked off and a draft release will be created. -4. This draft release triggers the [jenkins release workflow](https://build.ci.opensearch.org/job/opensearch-py-release/) as a result of which opensearch-py client is released on [PyPi](https://pypi.org/project/opensearch-py/). -5. Once the above release workflow is successful, the drafted release on GitHub is published automatically. -6. Add an "Unreleased" section to CHANGELOG, and increment version in [_version.py](opensearchpy/_version.py) to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/593). \ No newline at end of file +3. The [release-drafter#draft-a-release](.github/workflows/release-drafter.yml) workflow will be automatically kicked off and a draft release will be created. +4. The [release-drafter#pypi-publish](.github/workflows/release-drafter.yml) workflow will publish the release to [PyPi](https://pypi.org/project/opensearch-py/). +5. Add an "Unreleased" section to CHANGELOG, and increment version in [_version.py](opensearchpy/_version.py) to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/593). \ No newline at end of file diff --git a/jenkins/release.JenkinsFile b/jenkins/release.JenkinsFile deleted file mode 100644 index 0499e9980..000000000 --- a/jenkins/release.JenkinsFile +++ /dev/null @@ -1,13 +0,0 @@ -lib = library(identifier: 'jenkins@1.3.1', retriever: modernSCM([ - $class: 'GitSCMSource', - remote: 'https://github.com/opensearch-project/opensearch-build-libraries.git', -])) - -standardReleasePipelineWithGenericTrigger( - overrideDockerImage: 'opensearchstaging/ci-runner:release-centos7-clients-v4', - tokenIdCredential: 'jenkins-opensearch-py-generic-webhook-token', - causeString: 'A tag was cut on opensearch-project/opensearch-py repository causing this workflow to run', - downloadReleaseAsset: true, - publishRelease: true) { - publishToPyPi(credentialId: 'jenkins-opensearch-py-pypi-credentials') - } diff --git a/test_opensearchpy/run_tests.py b/test_opensearchpy/run_tests.py index c08fdc555..a9f01b7b4 100755 --- a/test_opensearchpy/run_tests.py +++ b/test_opensearchpy/run_tests.py @@ -163,7 +163,7 @@ def run_all(argv: Any = None) -> None: "test_opensearchpy/test_async/test_server_secured/", ] - # Jenkins/Github actions, only run server tests + # GitHub Actions, only run server tests if environ.get("TEST_TYPE") == "server": test_dir = abspath(dirname(__file__)) if secured: From 626e90e2cd27f8082f84a97956192624c334d3c4 Mon Sep 17 00:00:00 2001 From: dblock Date: Mon, 19 Aug 2024 18:58:07 -0400 Subject: [PATCH 3/3] Update compatibility matrix. Signed-off-by: dblock --- COMPATIBILITY.md | 2 +- RELEASING.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index bc35d1928..60419c89b 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -9,7 +9,7 @@ The below matrix shows the compatibility of the [`opensearch-py`](https://pypi.o | --- | --- | --- | | 1.0.0 | 1.0.0-1.2.4 | | | 1.1.0 | 1.3.0-1.3.7 | | -| 2.x.x | 1.0.0-2.14.0 | client works against OpenSearch 1.x as long as features removed in 2.0 are not used | +| 2.x.x | 1.0.0-2.16.0 | client works against OpenSearch 1.x as long as features removed in 2.0 are not used | ## Upgrading diff --git a/RELEASING.md b/RELEASING.md index fee20a8e7..18c062872 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -37,4 +37,4 @@ The release process is standard across repositories in this org and is run by a 2. Create a tag, e.g. v2.1.0, and push it to the GitHub repo. 3. The [release-drafter#draft-a-release](.github/workflows/release-drafter.yml) workflow will be automatically kicked off and a draft release will be created. 4. The [release-drafter#pypi-publish](.github/workflows/release-drafter.yml) workflow will publish the release to [PyPi](https://pypi.org/project/opensearch-py/). -5. Add an "Unreleased" section to CHANGELOG, and increment version in [_version.py](opensearchpy/_version.py) to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/593). \ No newline at end of file +5. Add an "Unreleased" section to [CHANGELOG](CHANGELOG.md), update the [COMPATIBILITY](COMPATIBILITY.md) matrix, and increment version in [_version.py](opensearchpy/_version.py) to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/593). \ No newline at end of file