@@ -14,7 +14,36 @@ nginx-formula
14
14
:scale: 100%
15
15
:target: https://github.com/semantic-release/semantic-release
16
16
17
- Formula to set up and configure nginx
17
+ Formula to set up and configure
18
+ `NGINX <https://www.nginx.com/ >`_.
19
+
20
+ .. list-table ::
21
+ :name: banner-breaking-changes-v1.0.0
22
+ :header-rows: 1
23
+ :widths: 1
24
+
25
+ * - WARNING: BREAKING CHANGES SINCE ``v1.0.0 ``
26
+ * - Prior to
27
+ `v1.0.0 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v1.0.0 >`_,
28
+ this formula provided two methods for managing NGINX;
29
+ the old method under ``nginx `` and the new method under ``nginx.ng ``.
30
+ The old method has now been removed and ``nginx.ng `` has been promoted to
31
+ be ``nginx `` in its place.
32
+
33
+ If you are not in a position to migrate, please pin your repo to the final
34
+ release tag before
35
+ `v1.0.0 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v1.0.0 >`_,
36
+ i.e.
37
+ `v0.56.1 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v0.56.1 >`_.
38
+
39
+ To migrate from ``nginx.ng ``, simply modify your pillar to promote the
40
+ entire section under ``nginx:ng `` so that it is under ``nginx `` instead.
41
+ So with the editor of your choice, highlight the entire section and then
42
+ unindent one level. Finish by removing the ``ng: `` line.
43
+
44
+ To migrate from the old ``nginx ``, first convert to ``nginx.ng `` under
45
+ `v0.56.1 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v0.56.1 >`_
46
+ and then follow the steps laid out in the paragraph directly above.
18
47
19
48
.. contents :: **Table of Contents**
20
49
0 commit comments