From 31329c3dae528b41f99c44d4059692c6ddeb4d50 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Sun, 13 Dec 2020 19:06:41 +0000 Subject: [PATCH] chore(release): 1.0.0 [skip ci] # [1.0.0](https://github.com/saltstack-formulas/consul-formula/compare/v0.13.0...v1.0.0) (2020-12-13) ### Bug Fixes * replace deprecated ui option with ui_config ([3830ade](https://github.com/saltstack-formulas/consul-formula/commit/3830ade3398b42c0053f5b094497d461eed836e2)) ### BREAKING CHANGES * This cannot be updated in a non-breaking fashion, but the least disruptive route was chosen. * If both `ui` and `ui_config.enabled` are set, `ui_config` takes precedence. Hence, the change may enable the UI on machines which had previously set `ui` to false. This is arguably better than defaulting to `false`, which would disable the UI where it is supposed to be enabled. * Removing the option entirely breaks similarly if users rely on the formula defaults, since Consul's default is `false` and the formula's default used to be `true`. * The only other way to break less would be to set both options, but then users would also have override both (which is not obvious and very annoying) and there would still be no way forward to when Consul actually removes the deprecated option. --- CHANGELOG.md | 25 +++++++++++++++++++++++++ FORMULA | 2 +- docs/CHANGELOG.rst | 28 ++++++++++++++++++++++++++++ 3 files changed, 54 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b74851d..feb44ef8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,30 @@ # Changelog +# [1.0.0](https://github.com/saltstack-formulas/consul-formula/compare/v0.13.0...v1.0.0) (2020-12-13) + + +### Bug Fixes + +* replace deprecated ui option with ui_config ([3830ade](https://github.com/saltstack-formulas/consul-formula/commit/3830ade3398b42c0053f5b094497d461eed836e2)) + + +### BREAKING CHANGES + +* This cannot be updated in a non-breaking fashion, but +the least disruptive route was chosen. +* If both `ui` and `ui_config.enabled` are set, +`ui_config` takes precedence. Hence, the change may enable the UI on +machines which had previously set `ui` to false. This is arguably better +than defaulting to `false`, which would disable the UI where it is +supposed to be enabled. +* Removing the option entirely breaks similarly if users +rely on the formula defaults, since Consul's default is `false` and the +formula's default used to be `true`. +* The only other way to break less would be to set both +options, but then users would also have override both (which is not +obvious and very annoying) and there would still be no way forward to +when Consul actually removes the deprecated option. + # [0.13.0](https://github.com/saltstack-formulas/consul-formula/compare/v0.12.0...v0.13.0) (2020-12-13) diff --git a/FORMULA b/FORMULA index ef244132..e1fdc9fe 100644 --- a/FORMULA +++ b/FORMULA @@ -1,7 +1,7 @@ name: consul os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Amazon, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, Solaris, SmartOS, Windows, MacOS os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD, Solaris, Windows, MacOS -version: 0.13.0 +version: 1.0.0 release: 1 minimum_version: 2017.7 summary: Consul formula diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index 8a75a210..304e7b32 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -2,6 +2,34 @@ Changelog ========= +`1.0.0 `_ (2020-12-13) +--------------------------------------------------------------------------------------------------------- + +Bug Fixes +^^^^^^^^^ + + +* replace deprecated ui option with ui_config (\ `3830ade `_\ ) + +BREAKING CHANGES +^^^^^^^^^^^^^^^^ + + +* This cannot be updated in a non-breaking fashion, but + the least disruptive route was chosen. +* If both ``ui`` and ``ui_config.enabled`` are set, + ``ui_config`` takes precedence. Hence, the change may enable the UI on + machines which had previously set ``ui`` to false. This is arguably better + than defaulting to ``false``\ , which would disable the UI where it is + supposed to be enabled. +* Removing the option entirely breaks similarly if users + rely on the formula defaults, since Consul's default is ``false`` and the + formula's default used to be ``true``. +* The only other way to break less would be to set both + options, but then users would also have override both (which is not + obvious and very annoying) and there would still be no way forward to + when Consul actually removes the deprecated option. + `0.13.0 `_ (2020-12-13) -----------------------------------------------------------------------------------------------------------