From 3e3194fd21ac18f3cc6ba122341310e27e60e994 Mon Sep 17 00:00:00 2001 From: zmstone Date: Mon, 4 Mar 2024 11:11:13 +0100 Subject: [PATCH] chore: upgrade to hocon 0.42.0 --- apps/emqx/rebar.config | 2 +- changes/ce/breaking-12634.en.md | 10 ++++++++++ changes/ce/feat-12517.en.md | 2 +- mix.exs | 2 +- rebar.config | 2 +- 5 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 changes/ce/breaking-12634.en.md diff --git a/apps/emqx/rebar.config b/apps/emqx/rebar.config index 8a2abb8c5..cbaae0b39 100644 --- a/apps/emqx/rebar.config +++ b/apps/emqx/rebar.config @@ -30,7 +30,7 @@ {esockd, {git, "https://github.com/emqx/esockd", {tag, "5.11.1"}}}, {ekka, {git, "https://github.com/emqx/ekka", {tag, "0.19.0"}}}, {gen_rpc, {git, "https://github.com/emqx/gen_rpc", {tag, "3.3.1"}}}, - {hocon, {git, "https://github.com/emqx/hocon.git", {tag, "0.41.0"}}}, + {hocon, {git, "https://github.com/emqx/hocon.git", {tag, "0.42.0"}}}, {emqx_http_lib, {git, "https://github.com/emqx/emqx_http_lib.git", {tag, "0.5.3"}}}, {pbkdf2, {git, "https://github.com/emqx/erlang-pbkdf2.git", {tag, "2.0.4"}}}, {recon, {git, "https://github.com/ferd/recon", {tag, "2.5.1"}}}, diff --git a/changes/ce/breaking-12634.en.md b/changes/ce/breaking-12634.en.md new file mode 100644 index 000000000..f5378799e --- /dev/null +++ b/changes/ce/breaking-12634.en.md @@ -0,0 +1,10 @@ +Triple-quote string values in HOCON config files no longer support escape sequence. + +The detailed information can be found in [this pull request](https://github.com/emqx/hocon/pull/290). +Here is a summary for the impact on EMQX users: + +- EMQX 5.6 is the first version to generate triple-quote strings in `cluster.hocon`, + meaning for generated configs, there is no compatibility issue. +- For user hand-crafted configs (such as `emqx.conf`) a thorough review is needed + to inspect if escape sequences are used (such as `\n`, `\r`, `\t` and `\\`), if yes, + such strings should be changed to regular quotes (one pair of `"`) instead of triple-quotes. diff --git a/changes/ce/feat-12517.en.md b/changes/ce/feat-12517.en.md index b26e3edc8..a5115a386 100644 --- a/changes/ce/feat-12517.en.md +++ b/changes/ce/feat-12517.en.md @@ -12,4 +12,4 @@ rule_xlu4 { ~""" } ``` -See [HOCON 0.41.0](https://github.com/emqx/hocon/releases/tag/0.41.0) release note for more dtails. +See [HOCON 0.42.0](https://github.com/emqx/hocon/releases/tag/0.42.0) release note for more dtails. diff --git a/mix.exs b/mix.exs index b8d88ebec..668459e24 100644 --- a/mix.exs +++ b/mix.exs @@ -72,7 +72,7 @@ defmodule EMQXUmbrella.MixProject do # in conflict by emqtt and hocon {:getopt, "1.0.2", override: true}, {:snabbkaffe, github: "kafka4beam/snabbkaffe", tag: "1.0.8", override: true}, - {:hocon, github: "emqx/hocon", tag: "0.41.0", override: true}, + {:hocon, github: "emqx/hocon", tag: "0.42.0", override: true}, {:emqx_http_lib, github: "emqx/emqx_http_lib", tag: "0.5.3", override: true}, {:esasl, github: "emqx/esasl", tag: "0.2.0"}, {:jose, github: "potatosalad/erlang-jose", tag: "1.11.2"}, diff --git a/rebar.config b/rebar.config index 137ffdfa4..5e6bafb15 100644 --- a/rebar.config +++ b/rebar.config @@ -97,7 +97,7 @@ {system_monitor, {git, "https://github.com/ieQu1/system_monitor", {tag, "3.0.3"}}}, {getopt, "1.0.2"}, {snabbkaffe, {git, "https://github.com/kafka4beam/snabbkaffe.git", {tag, "1.0.8"}}}, - {hocon, {git, "https://github.com/emqx/hocon.git", {tag, "0.41.0"}}}, + {hocon, {git, "https://github.com/emqx/hocon.git", {tag, "0.42.0"}}}, {emqx_http_lib, {git, "https://github.com/emqx/emqx_http_lib.git", {tag, "0.5.3"}}}, {esasl, {git, "https://github.com/emqx/esasl", {tag, "0.2.0"}}}, {jose, {git, "https://github.com/potatosalad/erlang-jose", {tag, "1.11.2"}}},