From 28bf7093be36e0bd47866e28aefff1a38cc5b2b0 Mon Sep 17 00:00:00 2001
From: Maxwell G <maxwell@gtmx.me>
Date: Wed, 11 Sep 2024 07:35:02 -0500
Subject: [PATCH] changelogs: categorize deprecations under deprecated_features
(#679)
These should be put under deprecated_features so they show up properly
in the generated changelog.
---
CHANGELOG.rst | 8 ++++----
changelogs/changelog.yaml | 4 ++--
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 76d83fe..cf1162f 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -45,8 +45,8 @@ Release Summary
This is a patch release of the ``community.mysql`` collection.
Besides a bugfix, it contains an important upcoming breaking-change information.
-Breaking Changes / Porting Guide
---------------------------------
+Deprecated Features
+-------------------
- mysql_user - the ``user`` alias of the ``name`` argument has been deprecated and will be removed in collection version 5.0.0. Use the ``name`` argument instead.
@@ -75,8 +75,8 @@ Minor Changes
- mysql_replication - Improve detection of IsReplica and IsPrimary by inspecting the dictionary returned from the SQL query instead of relying on variable types. This ensures compatibility with changes in the connector or the output of SHOW REPLICA STATUS and SHOW MASTER STATUS, allowing for easier maintenance if these change in the future.
- mysql_user - Add salt parameter to generate static hash for `caching_sha2_password` and `sha256_password` plugins.
-Breaking Changes / Porting Guide
---------------------------------
+Deprecated Features
+-------------------
- collection - support of mysqlclient connector is deprecated - use PyMySQL connector instead! We will stop testing against it in collection version 4.0.0 and remove the related code in 5.0.0 (https://github.com/ansible-collections/community.mysql/issues/654).
- mysql_info - The ``users_info`` filter returned variable ``plugin_auth_string`` contains the hashed password and it's misleading, it will be removed from community.mysql 4.0.0. Use the `plugin_hash_string` return value instead (https://github.com/ansible-collections/community.mysql/pull/629).
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
index ea7c09f..27ae315 100644
--- a/changelogs/changelog.yaml
+++ b/changelogs/changelog.yaml
@@ -99,7 +99,7 @@ releases:
release_date: '2022-04-26'
3.10.0:
changes:
- breaking_changes:
+ deprecated_features:
- collection - support of mysqlclient connector is deprecated - use PyMySQL
connector instead! We will stop testing against it in collection version 4.0.0
and remove the related code in 5.0.0 (https://github.com/ansible-collections/community.mysql/issues/654).
@@ -158,7 +158,7 @@ releases:
release_date: '2024-08-22'
3.10.1:
changes:
- breaking_changes:
+ deprecated_features:
- mysql_user - the ``user`` alias of the ``name`` argument has been deprecated
and will be removed in collection version 5.0.0. Use the ``name`` argument
instead.