Skip to content

Commit

Permalink
Add release details and bump the jenkins lib version (opensearch-proj…
Browse files Browse the repository at this point in the history
…ect#319)

* Add relese details and bump the jenkins lib version

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>

* Add changelog

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>

* Add steps

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>
Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>
Signed-off-by: Miki <miki@amazon.com>
  • Loading branch information
2 people authored and AMoo-Miki committed Jul 12, 2023
1 parent 7ab734c commit d9dac70
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 5 additions & 6 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ This document explains the release strategy for artifacts in this organization.

Given the current major release of 1.0, projects in this organization maintain the following active branches.

* **main**: The next _major_ release. This is the branch where all merges take place and code moves fast.
* **1.x**: The next _minor_ release. Once a change is merged into `main`, decide whether to backport it to `1.x`.
* **1.0**: The _current_ release. In between minor releases, only hotfixes (e.g. security) are backported to `1.0`.
- **main**: The next _major_ release. This is the branch where all merges take place and code moves fast.
- **1.x**: The next _minor_ release. Once a change is merged into `main`, decide whether to backport it to `1.x`.
- **1.0**: The _current_ release. In between minor releases, only hotfixes (e.g. security) are backported to `1.0`.

Label PRs with the next major version label (e.g. `2.0.0`) and merge changes into `main`. Label PRs that you believe need to be backported as `1.x` and `1.0`. Backport PRs by checking out the versioned branch, cherry-pick changes and open a PR against each target backport branch.

Expand All @@ -34,8 +34,7 @@ Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v
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 is responsible for drafting a new release on GitHub.
1. Before creating a draft release, this workflow creates a GitHub issue asking for approval from the [maintainers](MAINTAINERS.md). See sample [issue](https://github.com/gaiksaya/opensearch-js/issues/1). The maintainers need to approve in order to continue the workflow run.
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)
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)
4 changes: 2 additions & 2 deletions jenkins/release.JenkinsFile
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
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',
]))

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")
}

0 comments on commit d9dac70

Please sign in to comment.