diff --git a/README.org b/README.org index 29defda0c..d51b53dcf 100644 --- a/README.org +++ b/README.org @@ -1,11 +1,13 @@ * riak_kv ** Overview +[[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]] + Riak KV is an open source Erlang application that is distributed using the [[https://github.com/basho/riak_core][riak_core]] Erlang library. Riak KV provides a key/value datastore and features MapReduce, lightweight data relations, and several different client APIs. ** Quick Start - You must have [[http://erlang.org/download.html][Erlang/OTP R13B04]] or later and a GNU-style build + You must have [[http://erlang.org/download.html][Erlang/OTP 20 or 22]] or later and a GNU-style build system to compile and run =riak_kv=. The easiest way to utilize riak_kv is by installing the full Riak application available on [[https://github.com/basho/riak][Github]]. @@ -34,3 +36,14 @@ git push mine some-topic-branch #+END_SRC 6) A Basho engineer or community maintainer will review your patch and merge it into the main repository or send you feedback. + +** Testing + +#+BEGIN_SRC shell +# standard tests +./rebar3 do xref, dialyzer, eunit +# property-based tests +./rebar3 as test eqc +#+END_SRC + +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]] diff --git a/rebar.config b/rebar.config index 3a6ee7768..452b65624 100644 --- a/rebar.config +++ b/rebar.config @@ -47,7 +47,7 @@ ]}. {deps, [ - {riak_core, {git, "https://github.com/basho/riak_core.git", {branch, "develop-3.0"}}}, + {riak_core, {git, "https://github.com/basho/riak_core.git", {tag, "riak_kv-3.0.8"}}}, {sidejob, {git, "https://github.com/basho/sidejob.git", {tag, "2.1.0"}}}, {bitcask, {git, "https://github.com/basho/bitcask.git", {tag, "2.1.0"}}}, {redbug, {git, "https://github.com/massemanet/redbug", {tag, "1.2.2"}}}, @@ -55,8 +55,8 @@ {sext, {git, "https://github.com/uwiger/sext.git", {tag, "1.4.1"}}}, {riak_pipe, {git, "https://github.com/basho/riak_pipe.git", {tag, "riak_kv-3.0.5"}}}, {riak_dt, {git, "https://github.com/basho/riak_dt.git", {tag, "riak_kv-3.0.0"}}}, - {riak_api, {git, "https://github.com/basho/riak_api.git", {branch, "develop-3.0"}}}, + {riak_api, {git, "https://github.com/basho/riak_api.git", {tag, "3.0.8"}}}, {hyper, {git, "https://github.com/basho/hyper", {tag, "1.1.0"}}}, {kv_index_tictactree, {git, "https://github.com/martinsumner/kv_index_tictactree.git", {tag, "1.0.0"}}}, - {riakhttpc, {git, "https://github.com/basho/riak-erlang-http-client", {branch, "develop-3.0"}}} + {riakhttpc, {git, "https://github.com/basho/riak-erlang-http-client", {tag, "3.0.8"}}} ]}.