Skip to content

Commit

Permalink
chore: add version naming convention to release doc (#114)
Browse files Browse the repository at this point in the history
Signed-off-by: a3hadi <[email protected]>
  • Loading branch information
ayildirim21 committed Apr 11, 2024
1 parent b9e84bd commit 960c678
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This document explains the release process for the Java SDK. You can find the mo

Before releasing a new SDK version, make sure to update all references from the old version to the new one.
For example, the version in the `README.md`, as well as the `pom.xml` in the root and example directories should be updated (for [reference
](https://github.com/numaproj/numaflow-java/pull/89/files#diff-9c5fb3d1b7e3b0f54bc5c4182965c4fe1f9023d449017cece3005d3f90e8e4d8)). After making these changes, create a PR. Once merged, it will trigger the Docker Publish workflow, and should be included in the release.
](https://github.com/numaproj/numaflow-java/pull/89/files#diff-9c5fb3d1b7e3b0f54bc5c4182965c4fe1f9023d449017cece3005d3f90e8e4d8)). The specified version should follow the [semantic versioning](https://semver.org/) specification. After making these changes, create a PR. Once merged, it will trigger the `Docker Publish` workflow, and should be included in the release.
As a result, the correct SDK version will always be printed in the server information logs, and the example images will
always be using the latest changes (due to pointing to the local maven repository that is built).

Expand All @@ -17,7 +17,7 @@ Ensure that this change is merged and included in the release.
### How to Release

This can be done via the Github UI. In the `Releases` section of the Java SDK repo, click `Draft a new release`. Create a tag that has the same name as the version that you specified in the root
`pom.xml` prefixed with a 'v', and select it. Make the title the same as the tag. Click `Generate release notes` so that all the changes made since the last release are documented. If there are any major features or breaking
`pom.xml` prefixed with a `'v'`, and select it. Make the title the same as the tag. Click `Generate release notes` so that all the changes made since the last release are documented. If there are any major features or breaking
changes that you would like to highlight as part of the release, add those to the description as well. Then set the release as either pre-release or latest, depending
on your situation. Finally, click `Publish release`, and your version tag will be the newest release on the repository.

Expand Down

0 comments on commit 960c678

Please sign in to comment.