Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d553821

Browse files
committed
docs(readme): add warning banner about v1.0.0 breaking changes
1 parent cbcf87d commit d553821

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

docs/README.rst

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,36 @@ nginx-formula
1414
:scale: 100%
1515
:target: https://github.com/semantic-release/semantic-release
1616

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.
1847

1948
.. contents:: **Table of Contents**
2049

0 commit comments

Comments
 (0)