Skip to content

Commit ef092fb

Browse files
authored
Mas 308 release (#1800)
* Reformat README * Update README.org README seems to do markdown differently in this repo? Update with build badge and test reference
1 parent 616af6f commit ef092fb

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

README.org

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
* riak_kv
22
** Overview
33

4+
[[https://github.com/basho/riak_kv/actions][Build Status]] - [[https://github.com/basho/riak_kv/actions/workflows/erlang.yml/badge.svg?branch=develop-3.0]]
5+
46
Riak KV is an open source Erlang application that is distributed using the [[https://github.com/basho/riak_core][riak_core]] Erlang
57
library. Riak KV provides a key/value datastore and features MapReduce, lightweight data relations, and several different client APIs.
68

79
** Quick Start
8-
You must have [[http://erlang.org/download.html][Erlang/OTP R13B04]] or later and a GNU-style build
10+
You must have [[http://erlang.org/download.html][Erlang/OTP 20 or 22]] or later and a GNU-style build
911
system to compile and run =riak_kv=. The easiest way to utilize riak_kv is by installing the full
1012
Riak application available on [[https://github.com/basho/riak][Github]].
1113

@@ -34,3 +36,14 @@ git push mine some-topic-branch
3436
#+END_SRC
3537
6) A Basho engineer or community maintainer will review your patch
3638
and merge it into the main repository or send you feedback.
39+
40+
** Testing
41+
42+
#+BEGIN_SRC shell
43+
# standard tests
44+
./rebar3 do xref, dialyzer, eunit
45+
# property-based tests
46+
./rebar3 as test eqc
47+
#+END_SRC
48+
49+
For a more complete set of tests, update riak_kv in the full Riak application and run any appropriate [[https://github.com/basho/riak_test/tree/develop-3.0/groups][Riak riak_test groups]]

rebar.config

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,16 @@
4747
]}.
4848

4949
{deps, [
50-
{riak_core, {git, "https://github.com/basho/riak_core.git", {branch, "develop-3.0"}}},
50+
{riak_core, {git, "https://github.com/basho/riak_core.git", {tag, "riak_kv-3.0.8"}}},
5151
{sidejob, {git, "https://github.com/basho/sidejob.git", {tag, "2.1.0"}}},
5252
{bitcask, {git, "https://github.com/basho/bitcask.git", {tag, "2.1.0"}}},
5353
{redbug, {git, "https://github.com/massemanet/redbug", {tag, "1.2.2"}}},
5454
{recon, {git, "https://github.com/ferd/recon", {tag, "2.5.2"}}},
5555
{sext, {git, "https://github.com/uwiger/sext.git", {tag, "1.4.1"}}},
5656
{riak_pipe, {git, "https://github.com/basho/riak_pipe.git", {tag, "riak_kv-3.0.5"}}},
5757
{riak_dt, {git, "https://github.com/basho/riak_dt.git", {tag, "riak_kv-3.0.0"}}},
58-
{riak_api, {git, "https://github.com/basho/riak_api.git", {branch, "develop-3.0"}}},
58+
{riak_api, {git, "https://github.com/basho/riak_api.git", {tag, "3.0.8"}}},
5959
{hyper, {git, "https://github.com/basho/hyper", {tag, "1.1.0"}}},
6060
{kv_index_tictactree, {git, "https://github.com/martinsumner/kv_index_tictactree.git", {tag, "1.0.0"}}},
61-
{riakhttpc, {git, "https://github.com/basho/riak-erlang-http-client", {branch, "develop-3.0"}}}
61+
{riakhttpc, {git, "https://github.com/basho/riak-erlang-http-client", {tag, "3.0.8"}}}
6262
]}.

0 commit comments

Comments
 (0)