From d553821caf30b88099387f82b3b744be5a44e302 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Mon, 13 May 2019 02:38:15 +0100 Subject: [PATCH 1/2] docs(readme): add warning banner about `v1.0.0` breaking changes --- docs/README.rst | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/README.rst b/docs/README.rst index f9a9d4e5..b929ec32 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -14,7 +14,36 @@ nginx-formula :scale: 100% :target: https://github.com/semantic-release/semantic-release -Formula to set up and configure nginx +Formula to set up and configure +`NGINX `_. + +.. list-table:: + :name: banner-breaking-changes-v1.0.0 + :header-rows: 1 + :widths: 1 + + * - WARNING: BREAKING CHANGES SINCE ``v1.0.0`` + * - Prior to + `v1.0.0 `_, + this formula provided two methods for managing NGINX; + the old method under ``nginx`` and the new method under ``nginx.ng``. + The old method has now been removed and ``nginx.ng`` has been promoted to + be ``nginx`` in its place. + + If you are not in a position to migrate, please pin your repo to the final + release tag before + `v1.0.0 `_, + i.e. + `v0.56.1 `_. + + To migrate from ``nginx.ng``, simply modify your pillar to promote the + entire section under ``nginx:ng`` so that it is under ``nginx`` instead. + So with the editor of your choice, highlight the entire section and then + unindent one level. Finish by removing the ``ng:`` line. + + To migrate from the old ``nginx``, first convert to ``nginx.ng`` under + `v0.56.1 `_ + and then follow the steps laid out in the paragraph directly above. .. contents:: **Table of Contents** From 966efd30136b7e216bf296e63aef876acfba11ae Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Mon, 13 May 2019 01:59:29 +0000 Subject: [PATCH 2/2] chore(release): 1.0.3 [skip ci] ## [1.0.3](https://github.com/saltstack-formulas/nginx-formula/compare/v1.0.2...v1.0.3) (2019-05-13) ### Documentation * **readme:** add warning banner about `v1.0.0` breaking changes ([d553821](https://github.com/saltstack-formulas/nginx-formula/commit/d553821)) --- AUTHORS.md | 2 +- CHANGELOG.md | 7 +++++++ FORMULA | 2 +- docs/AUTHORS.rst | 2 +- docs/CHANGELOG.rst | 9 +++++++++ 5 files changed, 19 insertions(+), 3 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index 09e0d4fd..5b0ebe66 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -77,4 +77,4 @@ Avatar|Contributor|Contributions --- -Auto generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-05-12. +Auto generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-05-13. diff --git a/CHANGELOG.md b/CHANGELOG.md index e3bcc017..6e3436d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [1.0.3](https://github.com/saltstack-formulas/nginx-formula/compare/v1.0.2...v1.0.3) (2019-05-13) + + +### Documentation + +* **readme:** add warning banner about `v1.0.0` breaking changes ([d553821](https://github.com/saltstack-formulas/nginx-formula/commit/d553821)) + ## [1.0.2](https://github.com/saltstack-formulas/nginx-formula/compare/v1.0.1...v1.0.2) (2019-05-12) diff --git a/FORMULA b/FORMULA index 799044f0..d31f8253 100644 --- a/FORMULA +++ b/FORMULA @@ -1,7 +1,7 @@ name: nginx os: Debian, Ubuntu, RedHat, Fedora, CentOS, Suse, openSUSE os_family: Debian, RedHat, Suse -version: 1.0.2 +version: 1.0.3 release: 1 minimum_version: 2017.3 summary: nginx formula diff --git a/docs/AUTHORS.rst b/docs/AUTHORS.rst index 00b57674..c7610286 100644 --- a/docs/AUTHORS.rst +++ b/docs/AUTHORS.rst @@ -227,4 +227,4 @@ This list is sorted by the number of commits per contributor in *descending* ord ---- -Auto generated by a `forked version `_ of `gaocegege/maintainer `_ on 2019-05-12. +Auto generated by a `forked version `_ of `gaocegege/maintainer `_ on 2019-05-13. diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index 4c9be527..7b1119fd 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -2,6 +2,15 @@ Changelog ========= +`1.0.3 `_ (2019-05-13) +------------------------------------------------------------------------------------------------------- + +Documentation +^^^^^^^^^^^^^ + + +* **readme:** add warning banner about ``v1.0.0`` breaking changes (\ `d553821 `_\ ) + `1.0.2 `_ (2019-05-12) -------------------------------------------------------------------------------------------------------