Skip to content

Commit 3ac59e4

Browse files
author
nb
committed
fix(readme): add warning in docs/README.rst
1 parent 1a5d734 commit 3ac59e4

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/README.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,31 @@ php-formula
1616

1717
Formula to set up and configure php
1818

19+
.. list-table::
20+
:name: banner-breaking-changes-v1.0.0
21+
:header-rows: 1
22+
:widths: 1
23+
24+
* - WARNING: BREAKING CHANGES IN UPCOMING ``v1.0.0``
25+
* - This formula currently provides two methods for managing PHP; the old method
26+
under ``php`` and the new method under ``php.ng``.
27+
In upcoming `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_,
28+
the old method will be removed and ``php.ng`` will be promoted to ``php`` in its place.
29+
30+
If you are not in a position to migrate, you will need to pin your repo to
31+
the final release tag before
32+
`v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_,
33+
which is expected to be
34+
`v0.37.1 <https://github.com/saltstack-formulas/php-formula/releases/tag/v0.37.1>`_.
35+
36+
If you are currently using ``php.ng``, there is nothing to do until
37+
`v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_
38+
is released.
39+
40+
To migrate from the old ``php``, the first step is to convert to ``php.ng``,
41+
before `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_
42+
is released.
43+
1944
.. contents:: **Table of Contents**
2045

2146
General notes

0 commit comments

Comments
 (0)