From d553821caf30b88099387f82b3b744be5a44e302 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Mon, 13 May 2019 02:38:15 +0100 Subject: [PATCH] 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 f9a9d4e..b929ec3 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**