Skip to content

Commit

Permalink
chore(release): 1.0.0 [skip ci]
Browse files Browse the repository at this point in the history
# [1.0.0](v0.13.0...v1.0.0) (2020-12-13)

### Bug Fixes

* replace deprecated ui option with ui_config ([3830ade](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.
  • Loading branch information
semantic-release-bot committed Dec 13, 2020
1 parent 3830ade commit 31329c3
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 1 deletion.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)


Expand Down
2 changes: 1 addition & 1 deletion FORMULA
Original file line number Diff line number Diff line change
@@ -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
Expand Down
28 changes: 28 additions & 0 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,34 @@
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)
-----------------------------------------------------------------------------------------------------------

Expand Down

0 comments on commit 31329c3

Please sign in to comment.