Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparing for next developer iteration, 3.0.1. #448

Merged
merged 1 commit into from
Dec 12, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Preparing for next developer iteration, 3.0.1.
Signed-off-by: dblock <dblock@amazon.com>
  • Loading branch information
dblock committed Dec 12, 2023
commit 61f5aaf90a58d50a58ff2a7eb72ccaafd22e91c4
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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

14 changes: 8 additions & 6 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -33,9 +33,11 @@ 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).
Jakob3xD marked this conversation as resolved.
Show resolved Hide resolved
7. Draft and publish a [new GitHub release](https://github.com/opensearch-project/opensearch-go/releases/new) from the newly created tag.
8. 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
@@ -27,4 +27,4 @@
package version

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