-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
397fccb
commit fa365be
Showing
1 changed file
with
15 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,27 @@ | ||
# Unofficial java client for [Maelstrom] server | ||
|
||
Example of usage can be found in [lipinskipawel/whirlpool]. | ||
|
||
[Maelstrom]: https://github.com/jepsen-io/maelstrom | ||
|
||
## How to release maelstrom-java library | ||
[lipinskipawel/whirlpool]: https://github.com/lipinskipawel/whirlpool | ||
|
||
## Features | ||
|
||
Release process is semi-automated. It begins by adding a tag version (e.g. `v0.1.0`) to a specific commit and assigning | ||
version to `version` in `build.gradle.kts`. Tagged commit will be release as a new version of library. | ||
Currently, we are supporting 3 workloads | ||
|
||
Next release have to be triggered manually by Github action release. | ||
- echo | ||
- unique-ids | ||
- broadcast | ||
|
||
After that Github workflow will react on the release and publish library to Maven Central Repository. | ||
The rest of them are to be done | ||
|
||
- g-counter | ||
- kafka | ||
- txn-rw-register | ||
|
||
## License | ||
|
||
This project is [MIT] licensed. | ||
|
||
[MIT]: LICENSE |