From 06e8a1f68410ed981906ed6f57365fae39409e9d Mon Sep 17 00:00:00 2001 From: Sayali Gaikawad Date: Wed, 2 Nov 2022 11:32:08 -0700 Subject: [PATCH 1/3] Add relese details and bump the jenkins lib version Signed-off-by: Sayali Gaikawad --- RELEASING.md | 3 ++- jenkins/release.JenkinsFile | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 936115092..7597ec97a 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -31,4 +31,5 @@ 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 includes a [maintainer](MAINTAINERS.md) pushing a tag to this repository. This creates a draft release which then triggers the [jenkins release workflow](https://build.ci.opensearch.org/job/opensearch-js-release/) and releases the client on [npmjs](https://www.npmjs.com/package/@opensearch-project/opensearch). +See the GitHub [issue](https://github.com/opensearch-project/opensearch-build/issues/1234) for more details on end to end release workflow. diff --git a/jenkins/release.JenkinsFile b/jenkins/release.JenkinsFile index b281001c1..4d9bc7a33 100644 --- a/jenkins/release.JenkinsFile +++ b/jenkins/release.JenkinsFile @@ -1,4 +1,4 @@ -lib = library(identifier: 'jenkins@1.1.0', retriever: modernSCM([ +lib = library(identifier: 'jenkins@1.1.1', retriever: modernSCM([ $class: 'GitSCMSource', remote: 'https://github.com/opensearch-project/opensearch-build-libraries.git', ])) @@ -6,6 +6,6 @@ lib = library(identifier: 'jenkins@1.1.0', retriever: modernSCM([ 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") } From 757e1a9c86e5b662e60857f2c75465f63185dc76 Mon Sep 17 00:00:00 2001 From: Sayali Gaikawad Date: Wed, 2 Nov 2022 11:34:23 -0700 Subject: [PATCH 2/3] Add changelog Signed-off-by: Sayali Gaikawad --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2fb52d1a6..902f7461a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Added - Github workflow for changelog verification ([#306](https://github.com/opensearch-project/opensearch-js/pull/306)) - Add GitHub and Jenkins release workflow ([#317](https://github.com/opensearch-project/opensearch-js/pull/317)) +- Add release details to releasing.md ([319](https://github.com/opensearch-project/opensearch-js/pull/319)) ### Dependencies - Bumps `tsd` from 0.22.0 to 0.24.1 From 01d23b51e1f43b1c9405c7606ac4e50c90b82b98 Mon Sep 17 00:00:00 2001 From: Sayali Gaikawad Date: Wed, 2 Nov 2022 15:14:43 -0700 Subject: [PATCH 3/3] Add steps Signed-off-by: Sayali Gaikawad --- RELEASING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 7597ec97a..1e512ba44 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -31,5 +31,10 @@ Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v ## Releasing -The release process includes a [maintainer](MAINTAINERS.md) pushing a tag to this repository. This creates a draft release which then triggers the [jenkins release workflow](https://build.ci.opensearch.org/job/opensearch-js-release/) and releases the client on [npmjs](https://www.npmjs.com/package/@opensearch-project/opensearch). -See the GitHub [issue](https://github.com/opensearch-project/opensearch-build/issues/1234) for more details on end to end release workflow. +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) \ No newline at end of file