From 325dd555369cf6ecc31c9d2998a901164d707349 Mon Sep 17 00:00:00 2001 From: Michael Ruoss Date: Fri, 3 Nov 2023 19:42:31 +0100 Subject: [PATCH] release v5.0.0 --- CHANGELOG.md | 9 +++++++-- README.md | 4 ++-- mix.exs | 2 +- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ed3c8e9..b3262a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,13 +10,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + + +## [5.0.0] - 2023-11-03 + +Although this release contains only fixes but as the encoding changes, we +consider it a breaking change. Hence the major bump. + ### Fixed - handle "\n" strings - [#157](https://github.com/ufirstgroup/ymlr/issues/157),[#159](https://github.com/ufirstgroup/ymlr/pull/159) - handle empty list - [#163](https://github.com/ufirstgroup/ymlr/pull/163) - - ## [4.2.0] - 2023-08-18 ### Added diff --git a/README.md b/README.md index 5f6cc15..1d146e9 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The package can be installed by adding `ymlr` to your list of dependencies in `m ```elixir def deps do [ - {:ymlr, "~> 4.0"} + {:ymlr, "~> 5.0"} ] end ``` @@ -78,7 +78,6 @@ to parse it later using [`YamlElixir`'s `atoms` option](https://hexdocs.pm/yaml_elixir/readme.html#support-for-atoms), you can pass `atoms: true` as second argument to any of the `Ymlr` module's functions: - ```elixir iex> Ymlr.document!(%{a: 1}, atoms: true) """ @@ -88,6 +87,7 @@ iex> Ymlr.document!(%{a: 1}, atoms: true) ``` ### Encode maps with keys sorted + Maps in elixir, implemented by erlang `:maps`, internally are `flatmap`s or `hashmap`s by size. Large maps will be encoded in strange order. diff --git a/mix.exs b/mix.exs index ee6ac29..8522891 100644 --- a/mix.exs +++ b/mix.exs @@ -2,7 +2,7 @@ defmodule Ymlr.MixProject do use Mix.Project @source_url "https://github.com/ufirstgroup/ymlr" - @version "4.2.0" + @version "5.0.0" def project do [