Skip to content

Commit

Permalink
remove notes on semantic ver on release guide and add link to pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
nprizal committed Mar 28, 2024
1 parent 78174ac commit 19969e9
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,7 @@


## Release
To release a new version, opan a PR and update the version number in `version/VERSION`.
Once the PR is merged to `main`, a release pipeline will be triggered and the new version will be released.
To release a new version, open a PR and update the version number in `version/VERSION`.
Once the PR is merged to `main`, a [release pipeline](https://buildkite.com/buildkite/test-splitter-client-release) will be triggered and the new version will be released.
Currently, we only release to [GitHub](https://github.com/buildkite/test-splitter/releases). The release pipeline will generate the release notes and attach the compiled binary to the GitHub release.

We use [Semantic Version](https://semver.org) for the versioning.
The basic is:
```
x.y.z
```
1. x is MAJOR version, used for BREAKING CHANGES for example when the API is changed.
2. y is MINOR version, used for non breaking changes. This should be the default when releasing new features.
3. z is PATCH version, used for bug fixes for the MINOR version.

0 comments on commit 19969e9

Please sign in to comment.