Add release details and bump the jenkins lib version (#319)

* Add relese details and bump the jenkins lib version Signed-off-by: Sayali Gaikawad <[email protected]> * Add changelog Signed-off-by: Sayali Gaikawad <[email protected]> * Add steps Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: Sayali Gaikawad <[email protected]> Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
opensearch-project · Nov 9, 2022 · 9099a5c · 9099a5c
1 parent c3e3cac
commit 9099a5c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
 ### Added
+- Add release details to releasing.md ([319](https://github.com/opensearch-project/opensearch-js/pull/319))
 ### Dependencies
 ### Changed
 ### Deprecated

diff --git a/RELEASING.md b/RELEASING.md
@@ -31,4 +31,10 @@ Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v
 
 ## Releasing
 
-The release process is standard across repositories in this org and is run by a release manager volunteering from amongst [MAINTAINERS](MAINTAINERS.md).
+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-js-release/) as a result of which opensearch-js client is released on [npmjs](https://www.npmjs.com/package/@opensearch-project/opensearch).
+1. Once the above release workflow is successful, the drafted release on GitHub is published automatically.
+1. Increment "version" in package.json to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-js/pull/318)
diff --git a/jenkins/release.JenkinsFile b/jenkins/release.JenkinsFile
@@ -1,11 +1,11 @@
-lib = library(identifier: '[email protected].0', retriever: modernSCM([
+lib = library(identifier: '[email protected].1', retriever: modernSCM([
     $class: 'GitSCMSource',
     remote: 'https://github.com/opensearch-project/opensearch-build-libraries.git',
 ]))
 
 standardReleasePipelineWithGenericTrigger(
     tokenIdCredential: 'jenkins-opensearch-js-generic-webhook-token',
     causeString: 'A tag was cut on opensearch-project/opensearch-js repository causing this workflow to run',
-    publishRelease: true){
+    publishRelease: true) {
         publishToNpm(repository: 'https://github.com/opensearch-project/opensearch-js', tag: "$tag")
     }