Skip to content

Commit

Permalink
Document version auto-increment and fix typos.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <[email protected]>
  • Loading branch information
dblock committed Jun 20, 2024
1 parent 80dc741 commit 3e49f82
Showing 1 changed file with 39 additions and 11 deletions.
50 changes: 39 additions & 11 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
- [Feature Branches](#feature-branches)
- [Release Labels](#release-labels)
- [Releasing](#releasing)
- [Preparing for Release](#preparing-for-release)
- [Release](#release)
- [Preparing for Next Developer Iteration](#preparing-for-next-developer-iteration)

## Overview

Expand All @@ -13,17 +16,17 @@ This document explains the release strategy for artifacts in this organization.

### Release Branching

Given the current major release of 1.0, projects in this organization maintain the following active branches.
Given the current major release of 2.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 3.0. This is the branch where all merges take place and code moves fast.
* **2.x**: The next _minor_ release. Once a change is merged into `main`, decide whether to backport it to `2.x`.
* **2.0**: The _current_ release. In between minor releases, only hotfixes (e.g. security) are backported to `2.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.
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 `2.x` and `2.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 creating 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.
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

Expand All @@ -33,8 +36,33 @@ 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 containing release artifacts.
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-java/issues/1). The maintainers need to approve in order to continue the workflow run.
1. Once a release is drafted [opensearch-java-maven-sign-and-release/](https://build.ci.opensearch.org/job/opensearch-java-maven-sign-and-release/) jenkins workflow is triggered. The artifacts will be automcatically signed and published to maven.
1. Increment `systemProp.version` in [gradle.properties](gradle.properties) to the next patch release, e.g. `v2.1.1`, commit and push.
### Preparing for Release

1. Check out the branch being released, e.g. `2.x`.
2. Create a new branch that matches the version number being released, e.g. `2.10.5`.
3. Ensure `systemProp.version` in [gradle.properties](gradle.properties) matches the version being released.
4. Replace `## [Unreleased x.y]` with a version number and date, e.g. `## [2.11.0] - 06/20/2024` in [CHANGELOG](CHANGELOG.md).
5. Commit your changes, create a tag, e.g. `v2.1.0`, and push your changes and the new tag to GitHub.

### Release

The [release-drafter workflow](.github/workflows/release-drafter.yml) will be automatically kicked off and is responsible for drafting a new release on GitHub containing release artifacts. 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-java/issues/1). The maintainers need to approve in order to continue the workflow run.

Once a release is drafted [opensearch-java-maven-sign-and-release](https://build.ci.opensearch.org/job/opensearch-java-maven-sign-and-release/) Jenkins workflow is triggered. The artifacts will be automatically signed and published to maven.

### Preparing for Next Developer Iteration

An [increment version workflow](.github/workflows/increment-version.yml) will make a pull request to set `systemProp.version` in [gradle.properties](gradle.properties) to the next version.

Add an unreleased section to [CHANGELOG](CHANGELOG.md) in `main` and backport the change to `2.x`.

```markdown
## [Unreleased 2.x]
### Added
### Dependencies
### Changed
### Deprecated
### Removed
### Fixed
### Security
```

0 comments on commit 3e49f82

Please sign in to comment.