Add documentation

Signed-off-by: Sayali Gaikawad <[email protected]>

.github/workflows/release-drafter.yml

@@ -6,7 +6,7 @@ on:
       - "*"
 
 jobs:
-  build:
+  draft-a-release:
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -21,11 +21,11 @@ jobs:
       - uses: trstringer/manual-approval@v1
         with:
           secret: ${{ github.TOKEN }}
-          approvers: gaiksaya
-          minimum-approvals: 1
+          approvers: ${{ steps.get_data.outputs.approvers }}
+          minimum-approvals: 2
           issue-title: 'Release opensearch-cluster-cdk : ${{ steps.get_data.outputs.version }}'
           issue-body: "Please approve or deny the release of opensearch-cluster-cdk. **VERSION**: ${{ steps.get_data.outputs.version }} **TAG**: ${{ github.ref_name }}  **COMMIT**: ${{ github.sha }}"
-          exclude-workflow-initiator-as-approver: false
+          exclude-workflow-initiator-as-approver: true
       - name: Release
         uses: softprops/action-gh-release@v1
         with:

RELEASING.md

@@ -0,0 +1,17 @@
+- [Overview](#overview)
+- [Releasing](#releasing)
+
+## Overview
+
+This document explains the release strategy for artifacts in this organization.
+
+## 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. Create a tag, e.g. v2.1.0, and push it to the GitHub repo.
+2. The [release-drafter.yml](.github/workflows/release-drafter.yml) will be automatically kicked off.
+3. The above release drafter workflow creates an issue asking for confirmation about the release from the mainatiners. Once approved, it creates a draft release in the repository.
+4. This draft release triggers the [jenkins release workflow](https://build.ci.opensearch.org/job/opensearch-cluster-cdk-release/) as a result of which opensearch-cluster-cdk is released on [npmjs](https://www.npmjs.com/package/@opensearch-project/opensearch-cluster-cdk).
+5. Once the above release workflow is successful, the drafted release on GitHub is published automatically.
+6. Increment "version" in package.json to the next patch release, e.g. v2.1.1.

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "my-opensearch-cluster-cdk-test",
-  "version": "0.2.0",
+  "name": "opensearch-cluster-cdk",
+  "version": "1.0.0",
   "bin": {
     "cdk_v2": "bin/app.js"
   },