Skip to content

Commit bc0719a

Browse files
myiimyii
authored
Merge pull request #185 from sticky-note/fix/non-ng-deprecation
fix: warn formula users ng states will be promoted in `v1.0.0`
2 parents 08cd563 + 3ac59e4 commit bc0719a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+220
-2
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

‎php/adodb.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{%- from "php/map.jinja" import php with context %}
22
33
include:
4+
- php.deprecated
45
- php
56
67
php-adodb:

‎php/apc.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{%- from "php/map.jinja" import php with context %}
22
33
include:
4+
- php.deprecated
45
- php
56
67
php-apc:

‎php/apcu.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{%- from "php/map.jinja" import php with context %}
22
33
include:
4+
- php.deprecated
45
- php
56
67
php-apcu:

‎php/bcmath.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{%- from "php/map.jinja" import php with context %}
22
33
include:
4+
- php.deprecated
45
- php
56
67
php-bcmath:

‎php/cgi.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{%- from "php/map.jinja" import php with context %}
22
33
include:
4+
- php.deprecated
45
- php
56
67
php-cgi:

‎php/cli.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{%- from "php/map.jinja" import php with context %}
22
33
include:
4+
- php.deprecated
45
- php
56
67
php-cli:

‎php/composer.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
{%- set salt_user_home = salt['user.info'](salt_user).get('home', '/root') %}
1212
1313
include:
14+
- php.deprecated
1415
- php
1516
1617
get-composer:

‎php/curl.sls

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{%- from "php/map.jinja" import php with context %}
22
33
include:
4+
- php.deprecated
45
- php
56
67
php-curl:

‎php/deprecated.sls

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# -*- coding: utf-8 -*-
2+
# vim: ft=sls
3+
4+
{#- Evaluating as `False` by default, using this method since `defaults.yaml` not available in this repo #}
5+
{%- if not salt['config.get']('php').get('warning_messages', {}).get('v1.0.0', {}).get('mute_critical', False) %}
6+
php-deprecated-in-v1.0.0-test-succeed:
7+
test.succeed_without_changes:
8+
- name: |
9+
10+
11+
################################################################################
12+
# #
13+
# WARNING: BREAKING CHANGES IN UPCOMING VERSION `v1.0.0` #
14+
# #
15+
################################################################################
16+
# #
17+
# This formula currently provides two methods for managing PHP; the old method #
18+
# under `php` and the new method under `php.ng`. In upcoming `v1.0.0`, the old #
19+
# method will be removed and `php.ng` will be promoted to `php` in its place. #
20+
# #
21+
# If you are not in a position to migrate, you will need to pin your repo to #
22+
# the final release tag before `v1.0.0`, which is expected to be `v0.37.1`. #
23+
# #
24+
# If you are currently using `php.ng`, there is nothing to do until `v1.0.0` #
25+
# is released. #
26+
# #
27+
# To migrate from the old `php`, the first step is to convert to `php.ng`, #
28+
# before `v1.0.0` is released. #
29+
# #
30+
# To prevent this message being displayed again, set the pillar/config value: #
31+
# #
32+
# ``` #
33+
# php: #
34+
# warning_messages: #
35+
# v1.0.0: #
36+
# mute_critical: True #
37+
# ``` #
38+
# #
39+
################################################################################
40+
# - failhard: True
41+
{%- endif %}

0 commit comments

Comments
 (0)