From fc1213fb5a9e447633eb5a8b3e55b24b68e22b68 Mon Sep 17 00:00:00 2001
From: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>
Date: Fri, 14 Oct 2022 00:16:13 +0000
Subject: [PATCH] Add changelog and changelog verifier

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>
---
 .github/pull_request_template.md         | 16 ++++++++++++++++
 .github/workflows/changelog_verifier.yml | 18 ++++++++++++++++++
 CHANGELOG.md                             | 19 +++++++++++++++++++
 CONTRIBUTING.md                          | 18 ++++++++++++++++++
 4 files changed, 71 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..f326ecf767
--- /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
+- [ ] Commit changes are listed out in CHANGELOG.md file (See: [Changelog](https://github.com/opensearch-project/opensearch-net/blob/main/CONTRIBUTING.md#changelog))
+
+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 Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/opensearch-net/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..09466917d9
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,19 @@
+# CHANGELOG
+Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+
+## [Unreleased]
+### Added
+- Github workflow for changelog verification ([#111](https://github.com/opensearch-project/opensearch-net/pull/111))
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+
+[Unreleased]: https://github.com/opensearch-project/opensearch-net/compare/1.1.0...HEAD
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7aab00fba5..204790c3f2 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)
+  - [How to add my changes to CHANGELOG?](#how-to-add-my-changes-to-changelog)
 - [Review Process](#review-process)
 
 ## Contributing to OpenSearch
@@ -80,6 +82,22 @@ Signed-off-by: Jane Smith <jane.smith@email.com>
 
 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-Net maintains 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.
+
+Briefly, the changes are curated by version, with the changes to the main branch added chronologically to `Unreleased` version. Further, each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`.
+
+
+### How to add my changes to [CHANGELOG](CHANGELOG.md)?
+
+As a contributor, you must ensure that every pull request has the changes listed out within the corresponding version and appropriate section of [CHANGELOG](CHANGELOG.md) file.
+
+Adding in the change is 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](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.