Skip to content

Commit

Permalink
Use tag for rebar3_cuttlefish
Browse files Browse the repository at this point in the history
The rebar.lock file is not used for project_plugins, and so a tag must be used to consistently bring the same version of this software into the release.

The tagging of all dependencies has not been sone as part of this release.  This is to avoid confusion over tagging between 3.0 and 3.2 release paths, and remove some time-consuming activity prone to human error, form the release cycle.
  • Loading branch information
martinsumner committed Dec 29, 2022
1 parent b77ea43 commit 53bfbff
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
12 changes: 7 additions & 5 deletions RELEASE-NOTES.md
@@ -1,17 +1,19 @@
# Riak KV 3.2.0 Release Notes

This release is an OTP uplift release. Whereas release 3.0.n supports OTP 20 and OTP 22; the intention is for Release 3.2.n to support OTP 22, OTP 24, and OTP 25. There are notable potential throughput benefits of around 5% when using OTP 24/25 rather than OTP 22 where load is CPU bound. OTP 24 is currently the preferred platform for this release.
This release is an OTP uplift release. Whereas release 3.0.1 supports OTP 22; the intention is for Release 3.2.n to support OTP 22, OTP 24, and OTP 25. There are potential throughput benefits of up to 10% when using OTP 24/25 rather than OTP 22 where load is CPU bound. OTP 25 is currently the preferred platform for this release.

As part of this change, the [lager](https://github.com/erlang-lager/lager) dependancy has been removed, with OTP's internal [logger](https://www.erlang.org/doc/apps/kernel/logger_chapter.html) used instead. Any logging configuration should be updated as a part of the migrtaion, using the new options made available via [riak.conf](https://github.com/basho/riak/blob/0b5f9f1681352709c8312b2de7b7697c7b62a957/priv/riak.schema#L3-L70).
There are specific risks associated with OTP uplift releases due to the large volume of underlying changes inherited. It is advised that Riak users should take specific care to test this release in a pre-production environment. Please raise any issues discovered via Github.

There has been a significant overhaul of the release scripts in order to adopt changes within [relx](https://github.com/erlware/relx). Note that due to the updates in relx, `riak daemon` should be used instead of `riak start`. Some riak and riak-admin commands may also now return an additional `ok` output. Going forward, both `riak admin` and `riak-admin` should work for admin commands.
As part of this change, the [lager](https://github.com/erlang-lager/lager) dependancy has been removed, with OTP's internal [logger](https://www.erlang.org/doc/apps/kernel/logger_chapter.html) used instead. Any logging configuration should be updated as a part of the migration, using the new options made available via [riak.conf](https://github.com/basho/riak/blob/812ded6d64b080beeb068ba92f508556e6916d97/priv/riak.schema#L1-L35). Support for logging using syslog has been removed. The leveled backend will still write directly to erlang.log files, but this will be addressed in [a future release](https://github.com/martinsumner/leveled/issues/388).

Note that this release of Riak is packaged with a bespoke build of [rebar3](https://github.com/martinsumner/rebar3/tree/mas-alternative_deprecation_warning), this alters mainstream rebar3/relx to allow us control over deprecation warnings in relx.
There has been a significant overhaul of the release and packaging scripts in order to adopt changes within [relx](https://github.com/erlware/relx). Note that due to the updates in relx, `riak daemon` should be used instead of `riak start`. Some riak and riak-admin commands may also now return an additional `ok` output. Going forward, both `riak admin` and `riak-admin` should work for admin commands. Packaging suport has now been added for Alpine Linux and FreeBSD.

Packaging suport has now been added for Alpine Linux and FreeBSD.
Note that this release of Riak is packaged with a bespoke build of [rebar3](https://github.com/martinsumner/rebar3/tree/mas-alternative_deprecation_warning), this alters mainstream rebar3/relx to allow us control over deprecation warnings in relx.

When building from source, the `snappy` dependancy is now made rather than fetched using a cached package, so support for `cmake` is required to build. Note that on older versions of OSX the current version of snappy will not compile. This will be resolved when their is a formal release version of snappy containing [this fix](https://github.com/google/snappy/commit/8dd58a519f79f0742d4c68fbccb2aed2ddb651e8).

In this release, tagging of individual dependencies has not been used. Building consistently with the correct versions of dependencies is therefore dependent on the commit references being used from within the rebar.lock file.

# Riak KV 3.0.12 Release Notes

This is a general release of changes and fixes:
Expand Down
4 changes: 2 additions & 2 deletions rebar.config
Expand Up @@ -16,7 +16,7 @@
]}.

{project_plugins, [
{rebar3_cuttlefish, {git, "https://github.com/basho/rebar3_cuttlefish", {branch, "develop"}}}
{rebar3_cuttlefish, {git, "https://github.com/basho/rebar3_cuttlefish", {tag, "0.3.0"}}}
]}.

{cuttlefish, [
Expand All @@ -41,7 +41,7 @@
]}
]}.

{relx, [{release, {riak, "3.2.0rc1"},
{relx, [{release, {riak, "3.2.0"},
[kernel,
stdlib,
public_key,
Expand Down
13 changes: 7 additions & 6 deletions rebar.lock
Expand Up @@ -14,15 +14,15 @@
1},
{<<"clique">>,
{git,"https://github.com/basho/clique.git",
{ref,"47c4aca38095e6b9397284ed6422d268fd287644"}},
{ref,"3929fa5aeed341b407e16479626ff6b9dddf2ea3"}},
2},
{<<"cluster_info">>,
{git,"https://github.com/basho/cluster_info",
{ref,"55b12ebb60883766fd0077dac43b266fb5eb6c69"}},
0},
{<<"cuttlefish">>,
{git,"https://github.com/kyorai/cuttlefish.git",
{ref,"7afaad94e372da0252b0e0c066e8b585272968e4"}},
{git,"https://github.com/basho/cuttlefish.git",
{ref,"cb3df6a917ee93374de2b881e138e3dc6e9bf5cf"}},
3},
{<<"ebloom">>,
{git,"https://github.com/basho/ebloom.git",
Expand All @@ -37,7 +37,10 @@
{ref,"66c287e24ceff337f622e3f58e0b4a3ab9ced0f0"}},
2},
{<<"folsom">>,{pkg,<<"folsom">>,<<"1.0.0">>},3},
{<<"getopt">>,{pkg,<<"getopt">>,<<"1.0.2">>},4},
{<<"getopt">>,
{git,"https://github.com/martinsumner/getopt.git",
{ref,"5d2b27dab5d31669764dc759e44c2d96cac01a4e"}},
4},
{<<"hut">>,{pkg,<<"hut">>,<<"1.3.0">>},3},
{<<"hyper">>,
{git,"https://github.com/basho/hyper",
Expand Down Expand Up @@ -149,14 +152,12 @@
{pkg_hash,[
{<<"bear">>, <<"430419C1126B477686CDE843E88BA0F2C7DC5CDF0881C677500074F704339A99">>},
{<<"folsom">>, <<"50ECC998D2149939F1D5E0AA3E32788F8ED16A58E390D81B5C0BE4CC4EF25589">>},
{<<"getopt">>, <<"33D9B44289FE7AD08627DDFE1D798E30B2DA0033B51DA1B3A2D64E72CD581D02">>},
{<<"hut">>, <<"71F2F054E657C03F959CF1ACC43F436EA87580696528CA2A55C8AFB1B06C85E7">>},
{<<"parse_trans">>, <<"6E6AA8167CB44CC8F39441D05193BE6E6F4E7C2946CB2759F015F8C56B76E5FF">>},
{<<"setup">>, <<"05F69185A5EB71474C9BC6BA892565651EC7507791F85632B7B914DBFE130510">>}]},
{pkg_hash_ext,[
{<<"bear">>, <<"157B67901ADF84FF0DA6EAE035CA1292A0AC18AA55148154D8C582B2C68959DB">>},
{<<"folsom">>, <<"DD6AB97278E94F9E4CFC43E188224A7B8C7EAEC0DD2E935007005177F3EEBB0E">>},
{<<"getopt">>, <<"A0029AEA4322FB82A61F6876A6D9C66DC9878B6CB61FAA13DF3187384FD4EA26">>},
{<<"hut">>, <<"7E15D28555D8A1F2B5A3A931EC120AF0753E4853A4C66053DB354F35BF9AB563">>},
{<<"parse_trans">>, <<"620A406CE75DADA827B82E453C19CF06776BE266F5A67CFF34E1EF2CBB60E49A">>},
{<<"setup">>, <<"EFD072578F0CF85BEA96CAAFFC7ADB0992398272522660A136E10567377071C5">>}]}
Expand Down

0 comments on commit 53bfbff

Please sign in to comment.