Skip to content

Commit 7f6b18e

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

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/README.rst

+19
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,25 @@ 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 FOR 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`. In upcoming `v1.0.0`, the old
27+
method will be removed and `php.ng` will be promoted to `php` in its place.
28+
29+
If you are not in a position to migrate, you will need to pin your repo to
30+
the final release tag before `v1.0.0`, which is expected to be `v0.37.1`.
31+
32+
If you are currently using `php.ng`, there is nothing to do until `v1.0.0`
33+
is released.
34+
35+
To migrate from the old `php`, the first step is to convert to `php.ng`,
36+
before `v1.0.0` is released.
37+
1938
.. contents:: **Table of Contents**
2039

2140
General notes

0 commit comments

Comments
 (0)