aluminium reference update to 3003

This commit is contained in:
Frode Gundersen 2021-03-05 12:46:07 -07:00 committed by Megan Wilhite
parent b4c356c5cb
commit 2fdb5d4451
10 changed files with 24 additions and 15 deletions

View file

@ -20,14 +20,14 @@ Salt feature releases are based on the Periodic Table. Any new features going
into the ``master`` branch will be named after the next element in the Periodic
Table. For example, Magnesium was the feature release name associated with the
``v3002`` tag. At that point in time, any new features going into the
``master`` branch, after ``v3002`` was tagged, were part of the Aluminium feature
``master`` branch, after ``v3002`` was tagged, were part of the 3003 feature
release.
A deprecation warning should be in place for at least two major releases before
the deprecated code and its accompanying deprecation warning are removed. More
time should be given for more complex changes. For example, if the current
release under development is ``3001``, the deprecated code and associated
warnings should remain in place and warn for at least ``Aluminium``.
warnings should remain in place and warn for at least ``3003``.
To help in this deprecation task, salt provides
:func:`salt.utils.versions.warn_until <salt.utils.versions.warn_until>`. The
@ -45,13 +45,13 @@ Consider the following example:
def some_function(bar=False, foo=None):
if foo is not None:
salt.utils.versions.warn_until(
"Aluminium",
"3003",
"The 'foo' argument has been deprecated and its "
"functionality removed, as such, its usage is no longer "
"required.",
)
Development begins on ``Aluminium``, or ``v3003``, after the ``v3002`` tag is
Development begins on ``3003``, or ``v3003``, after the ``v3002`` tag is
applied to the ``master`` branch. Once this occurs, all uses of the
``warn_until`` function targeting ``Aluminium``, along with the code they are
``warn_until`` function targeting ``3003``, along with the code they are
warning about should be removed from the code.

View file

@ -966,7 +966,7 @@ Example:
Renamed from ``json_decode_list`` to ``json_encode_list``. When you encode
something you get bytes, and when you decode, you get your locale's
encoding (usually a ``unicode`` type). This filter was incorrectly-named
when it was added. ``json_decode_list`` will be supported until the Aluminium
when it was added. ``json_decode_list`` will be supported until the 3003
release.
.. deprecated:: 2018.3.3,2019.2.0
The :jinja_ref:`tojson` filter accomplishes what this filter was designed
@ -999,7 +999,7 @@ Returns:
Renamed from ``json_decode_dict`` to ``json_encode_dict``. When you encode
something you get bytes, and when you decode, you get your locale's
encoding (usually a ``unicode`` type). This filter was incorrectly-named
when it was added. ``json_decode_dict`` will be supported until the Aluminium
when it was added. ``json_decode_dict`` will be supported until the 3003
release.
.. deprecated:: 2018.3.3,2019.2.0
The :jinja_ref:`tojson` filter accomplishes what this filter was designed

View file

@ -749,7 +749,7 @@ Cloud Deprecations
Jinja Filter Deprecations
-------------------------
- The following jinja filters are set to be removed in the Aluminium release:
- The following jinja filters are set to be removed in the 3003 release:
- :jinja_ref:`json_decode_dict` in favor of :jinja_ref:`tojson`
- :jinja_ref:`json_decode_list` in favor of :jinja_ref:`tojson`

View file

@ -0,0 +1,8 @@
.. _release-3004:
==========================================
Salt 3004 Release Notes - Codename Silicon
==========================================
Salt 3004 is an *unreleased* upcoming feature release.

View file

@ -20,6 +20,7 @@ Previous Releases
:maxdepth: 1
:glob:
3003*
3002*
3001*
3000*
@ -41,7 +42,7 @@ Upcoming Release
:maxdepth: 1
:glob:
3003*
3004*
.. seealso:: :ref:`Legacy salt-cloud release docs <legacy-salt-cloud-release-notes>`

View file

@ -97,7 +97,7 @@ def _auth(profile=None, api_version=2, **connection_args):
Only intended to be used within glance-enabled modules
"""
__utils__["versions.warn_until"](
"Aluminium",
"3003",
(
"The glance module has been deprecated and will be removed in {version}. "
"Please update to using the glanceng module"

View file

@ -107,7 +107,7 @@ def image_present(
'qcow2', 'aki', 'ari' or 'ami')
"""
__utils__["versions.warn_until"](
"Aluminium",
"3003",
(
"The glance state module has been deprecated and will be removed in {version}. "
"Please update to using the glance_image state module"

View file

@ -585,7 +585,7 @@ def encode(
return data
@jinja_filter("json_decode_dict") # Remove this for Aluminium
@jinja_filter("json_decode_dict") # Remove this for 3003
@jinja_filter("json_encode_dict")
def encode_dict(
data,
@ -654,7 +654,7 @@ def encode_dict(
return ret
@jinja_filter("json_decode_list") # Remove this for Aluminium
@jinja_filter("json_decode_list") # Remove this for 3003
@jinja_filter("json_encode_list")
def encode_list(
data,

View file

@ -103,7 +103,7 @@ class SaltNeutron(NeutronShell):
Set up neutron credentials
"""
salt.utils.versions.warn_until(
"Aluminium",
"3003",
(
"The neutron module has been deprecated and will be removed in {version}. "
"Please update to using the neutronng module"

View file

@ -93,7 +93,7 @@ class SaltStackVersion:
"Neon": (3000,),
"Sodium": (3001,),
"Magnesium": (3002,),
"Aluminium": (MAX_SIZE - 96, 0),
"Aluminium": (3003,),
"Silicon": (MAX_SIZE - 95, 0),
"Phosphorus": (MAX_SIZE - 94, 0),
# pylint: disable=E8265