From f815c22ac8e807218750ba03b49cccf84e1efdfe Mon Sep 17 00:00:00 2001 From: Harsha Vamsi Kalluri Date: Fri, 14 Oct 2022 17:13:12 +0000 Subject: [PATCH 1/2] Update literature Signed-off-by: Harsha Vamsi Kalluri --- .github/pull_request_template.md | 16 ++++++++++++++++ .github/workflows/changelog_verifier.yml | 18 ++++++++++++++++++ CHANGELOG.md | 20 ++++++++++++++++++++ CONTRIBUTING.md | 19 +++++++++++++++++++ 4 files changed, 73 insertions(+) create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/changelog_verifier.yml create mode 100644 CHANGELOG.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..f8b8a2d143 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +### Description +[Describe what this change achieves] + +### Issues Resolved +[List any issues this PR will resolve] + +### Check List +- [ ] New functionality includes testing. + - [ ] All tests pass. +- [ ] New functionality has been documented. + - [ ] New functionality has comments added. +- [ ] Commits are signed per the DCO using --signoff. +- [ ] [CHANGELOG](https://github.com/opensearch-project/opensearch-java/blob/main/CONTRIBUTING.md#changelog) has been updated. + +By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. +For more information on following the Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/opensearch-java/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). \ No newline at end of file diff --git a/.github/workflows/changelog_verifier.yml b/.github/workflows/changelog_verifier.yml new file mode 100644 index 0000000000..96f99f17b0 --- /dev/null +++ b/.github/workflows/changelog_verifier.yml @@ -0,0 +1,18 @@ +name: "Changelog Verifier" +on: + pull_request: + types: [opened, edited, review_requested, synchronize, reopened, ready_for_review, labeled, unlabeled] + +jobs: + # Enforces the update of a changelog file on every pull request + verify-changelog: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + ref: ${{ github.event.pull_request.head.sha }} + + - uses: dangoslen/changelog-enforcer@v3 + with: + skipLabels: "autocut" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..9373e0bf7e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# CHANGELOG +Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) + +## [Unreleased] +### Added +- Github workflow for changelog verification ([#239](https://github.com/opensearch-project/opensearch-java/pull/239)) + +### Changed +- Update literature around changelog contributions in CONTRIBUTING.md ([#242](https://github.com/opensearch-project/opensearch-java/pull/242)) + +### Deprecated + +### Removed + +### Fixed + +### Security + + +[Unreleased]: https://github.com/opensearch-project/opensearch-java/compare/2.0...HEAD \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9638b01a23..2f7b12c319 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,8 @@ - [Feature Requests](#feature-requests) - [Contributing Code](#contributing-code) - [Developer Certificate of Origin](#developer-certificate-of-origin) +- [Changelog](#changelog) + - [Adding changes](#adding-changes) - [Review Process](#review-process) ## Contributing to OpenSearch @@ -80,6 +82,23 @@ Signed-off-by: Jane Smith You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message. +## Changelog + +OpenSearch-Java maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. + +The changes are curated by version, with the changes to the main branch added chronologically to the `Unreleased` version. Each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`. + + +### Adding changes + +As a contributor, you must ensure that every pull request has its changes listed out within the corresponding version and appropriate section of the [CHANGELOG](CHANGELOG.md) file. + +Adding in the change is a two step process - +1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR. + +2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there. + + ## Review Process We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](https://github.com/opensearch-project/opensearch-java/issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction. From b77c8e3dce10459f4da53162a8af43d28c639dcc Mon Sep 17 00:00:00 2001 From: Harsha Vamsi Kalluri Date: Tue, 18 Oct 2022 16:50:59 +0000 Subject: [PATCH 2/2] Removing pr template and updating language Signed-off-by: Harsha Vamsi Kalluri --- .github/pull_request_template.md | 16 ---------------- CONTRIBUTING.md | 7 +++---- java-client/build.gradle.kts | 8 +++++++- 3 files changed, 10 insertions(+), 21 deletions(-) delete mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index f8b8a2d143..0000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -### Description -[Describe what this change achieves] - -### Issues Resolved -[List any issues this PR will resolve] - -### Check List -- [ ] New functionality includes testing. - - [ ] All tests pass. -- [ ] New functionality has been documented. - - [ ] New functionality has comments added. -- [ ] Commits are signed per the DCO using --signoff. -- [ ] [CHANGELOG](https://github.com/opensearch-project/opensearch-java/blob/main/CONTRIBUTING.md#changelog) has been updated. - -By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. -For more information on following the Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/opensearch-java/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f7b12c319..36bc8c0711 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ - [Contributing Code](#contributing-code) - [Developer Certificate of Origin](#developer-certificate-of-origin) - [Changelog](#changelog) - - [Adding changes](#adding-changes) + - [Adding Changes](#adding-changes) - [Review Process](#review-process) ## Contributing to OpenSearch @@ -84,12 +84,12 @@ You may type this line on your own when writing your commit messages. However, i ## Changelog -OpenSearch-Java maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. +OpenSearch-java maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. The changes are curated by version, with the changes to the main branch added chronologically to the `Unreleased` version. Each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`. -### Adding changes +### Adding Changes As a contributor, you must ensure that every pull request has its changes listed out within the corresponding version and appropriate section of the [CHANGELOG](CHANGELOG.md) file. @@ -98,7 +98,6 @@ Adding in the change is a two step process - 2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there. - ## Review Process We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](https://github.com/opensearch-project/opensearch-java/issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction. diff --git a/java-client/build.gradle.kts b/java-client/build.gradle.kts index abd053094f..307c75393b 100644 --- a/java-client/build.gradle.kts +++ b/java-client/build.gradle.kts @@ -74,6 +74,12 @@ tasks.withType { ) } +tasks.withType().configureEach{ + options { + encoding = "UTF-8" + } +} + tasks.withType { doFirst { if (rootProject.extra.has("gitHashFull")) { @@ -133,7 +139,7 @@ dependencies { val opensearchVersion = "2.3.0" val jacksonVersion = "2.13.4" - val jacksonDatabindVersion = "2.13.4" + val jacksonDatabindVersion = "2.13.4.2" // Apache 2.0 implementation("org.opensearch.client", "opensearch-rest-client", opensearchVersion)