Skip to content

Commit

Permalink
Preparing for next developer iteration, 3.0.1.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <[email protected]>
  • Loading branch information
dblock committed Dec 12, 2023
1 parent 8d09ba8 commit 7a2b5a4
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [Unreleased 3.0.1]
### Dependencies
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security

## [3.0.0]
### Dependencies

Expand Down
13 changes: 7 additions & 6 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,10 @@ 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. Adjust the [CHANGELOG](CHANGELOG.md) by Replacing the `Unreleased` section with the new version.
2. Add a comparison link to the new version at the bottom of the [CHANGELOG](CHANGELOG.md).
3. Adjust the internal client version in the [internal/version/version.go](internal/version/version.go) file.
4. Create a PR with the changes and merge it into main.
5. Create a tag, e.g. `v3.0.1`, and push it to the GitHub repo. This makes the new version available on https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3.
6. Create a new `Unreleased` section in the [CHANGELOG](CHANGELOG.md) and merge it into main.
1. Ensure that the version in [version.go](internal/version/version.go) is correct for the next release.
2. For major version releases, ensure that all references are up-to-date, e.g. `github.com/opensearch-project/opensearch-go/v3`, see [opensearch-go#444](https://github.com/opensearch-project/opensearch-go/pull/444).
3. Edit the [CHANGELOG](CHANGELOG.md) and replace the `Unreleased` section with the version about to be released.
4. Add a comparison link to the new version at the bottom of the [CHANGELOG](CHANGELOG.md).
5. Create a pull request with the changes into `main`, e.g. [opensearch-go#443](https://github.com/opensearch-project/opensearch-go/pull/443).
6. Create a tag, e.g. `v3.0.1`, and push it to the GitHub repo. This [makes the new version available](https://go.dev/doc/modules/publishing) on [pkg.go.dev](https://pkg.go.dev/github.com/opensearch-project/opensearch-go).
7. Create a new `Unreleased` section in the [CHANGELOG](CHANGELOG.md), increment version in [version.go](internal/version/version.go) to the next developer iteration (e.g. `3.0.2`), and make a pull request with this change into `main`, e.g. [opensearch-go#448](https://github.com/opensearch-project/opensearch-go/pull/448).
2 changes: 1 addition & 1 deletion internal/version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@
package version

// Client returns the client version as a string.
const Client = "3.0.0"
const Client = "3.0.1"

0 comments on commit 7a2b5a4

Please sign in to comment.