Skip to content

Latest commit

 

History

History
27 lines (23 loc) · 1.32 KB

RELEASING.md

File metadata and controls

27 lines (23 loc) · 1.32 KB

Steps to cut a release

DO NOT cut a tag by going to release section of Github UI. It will mess up the Github Action.

Note: A maintainer must remember to perform steps 1, 2 and 4.

  1. Run these commands from the upstream opensearch-protobufs repository, not a forked one. Check that upstream is set to:
~/opensearch-protobufs on [main] % git remote -v
upstream        git@github.com:opensearch-project/opensearch-protobufs.git (fetch)
upstream        git@github.com:opensearch-project/opensearch-protobufs.git (push)

Then run:

git checkout main
git fetch upstream
git rebase upstream/main
git tag <version>
git push upstream <version>
  1. Wait for Github Actions to run and open the newly created issue. Two maintainers should comment approve in the issue.
  2. Wait for Jenkins to be triggered, pull the artifacts built by Actions, push to sonatype release channel on remote. Wait for an hour or so for Sonatype to copy it into Maven Central.
  3. Bump version.properties, update release-notes, and clean up entries from CHANGELOG.md via a PR.

Maintaining Compatibility Matrix

When a new OpenSearch version is released, update the COMPATIBILITY.md by adding a new column for that version and marking compatibility with existing protobuf versions.