Skip to content

RELEASING.md

Latest commit

 

History

History
45 lines (31 loc) · 2.93 KB

RELEASING.md

File metadata and controls

45 lines (31 loc) · 2.93 KB
Raw

Overview

This document explains the release strategy for artifacts in this organization.

Branching

Release Branching

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.

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

Feature Branches

Do not create branches in the upstream repo, use your fork, for the exception of long lasting feature branches that require active collaboration from multiple developers. Name feature branches feature/<thing>. Once the work is merged to main, please make sure to delete the feature branch.

Release Labels

Repositories create consistent release labels, such as v1.0.0, v1.1.0 and v2.0.0, as well as patch and backport. Use release labels to target an issue or a PR for a given release.

Releasing

The release process is standard across repositories in this org and is run by a release manager volunteering from amongst maintainers.

  1. Identify the commit to release and create a tag on it, pushing to the upstream repo:
git fetch origin
git tag <tag-name> <commit-sha>
git push origin <tag-name>
  1. The release-drafter.yml will be automatically kicked off and a pre-release will be created.
  2. This pre-release triggers the jenkins release workflow as a result of which the driver is released and published on artifacts (https://artifacts.opensearch.org/opensearch-clients/odbc/). Please note that the release workflow is triggered only if created release is in pre-release state. Manual update on the download page is required after that, see website repo.
  3. Once the above release workflow is successful, it creates a GitHub issue requesting maintainers to manually publish the pre-release to release on GitHub.
  4. Increment DRIVER_PACKAGE_VERSION in src/CMakeLists.txt to the next iteration, e.g. 1.0.0.1 See example.