Release 3.10.0 commit (#667)

ansible-collections · Aug 22, 2024 · 37a718c · 37a718c
1 parent a9f9806
commit 37a718c
Show file tree

Hide file tree

Showing 14 changed files with 100 additions and 44 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,11 +1,48 @@
-========================================
-Community MySQL Collection Release Notes
-========================================
+====================================================
+Community MySQL and MariaDB Collection Release Notes
+====================================================
 
 .. contents:: Topics
 
 This changelog describes changes after version 2.0.0.
 
+v3.10.0
+=======
+
+Release Summary
+---------------
+
+This is a minor release of the ``community.mysql`` collection.
+This changelog contains all changes to the modules and plugins in this
+collection that have been made after the previous release.
+
+Minor Changes
+-------------
+
+- mysql_info - Add ``tls_requires`` returned value for the ``users_info`` filter (https://github.com/ansible-collections/community.mysql/pull/628).
+- mysql_info - return a database server engine used (https://github.com/ansible-collections/community.mysql/issues/644).
+- mysql_replication - Adds support for `CHANGE REPLICATION SOURCE TO` statement (https://github.com/ansible-collections/community.mysql/issues/635).
+- mysql_replication - Adds support for `SHOW BINARY LOG STATUS` and `SHOW BINLOG STATUS` on getprimary mode.
+- 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
+--------------------------------
+
+- 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).
+
+Bugfixes
+--------
+
+- mysql_info - Add ``plugin_hash_string`` to ``users_info`` filter's output. The existing ``plugin_auth_string`` contained the hashed password and thus is missleading, it will be removed from community.mysql 4.0.0. (https://github.com/ansible-collections/community.mysql/pull/629).
+- mysql_user - Added a warning to update_password's on_new_username option if multiple accounts with the same username but different passwords exist (https://github.com/ansible-collections/community.mysql/pull/642).
+- mysql_user - Fix ``tls_requires`` not removing ``SSL`` and ``X509`` when sets as empty (https://github.com/ansible-collections/community.mysql/pull/628).
+- mysql_user - Fix idempotence when using variables from the ``users_info`` filter of ``mysql_info`` as an input (https://github.com/ansible-collections/community.mysql/pull/628).
+- mysql_user - Fixed an IndexError in the update_password functionality introduced in PR https://github.com/ansible-collections/community.mysql/pull/580 and released in community.mysql 3.8.0. If you used this functionality, please avoid versions 3.8.0 to 3.9.0 (https://github.com/ansible-collections/community.mysql/pull/642).
+- mysql_user - add correct ``ed25519`` auth plugin handling (https://github.com/ansible-collections/community.mysql/issues/6).
+- mysql_variables - fix the module always changes on boolean values (https://github.com/ansible-collections/community.mysql/issues/652).
+
 v3.9.0
 ======
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -97,6 +97,65 @@ releases:
     - 307-mysql_user_add_if_exists_to_drop.yml
     - 329-mysql_role-remove-redudant-connection-closing.yml
     release_date: '2022-04-26'
+  3.10.0:
+    changes:
+      breaking_changes:
+      - 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).
+      bugfixes:
+      - mysql_info - Add ``plugin_hash_string`` to ``users_info`` filter's output.
+        The existing ``plugin_auth_string`` contained the hashed password and thus
+        is missleading, it will be removed from community.mysql 4.0.0. (https://github.com/ansible-collections/community.mysql/pull/629).
+      - mysql_user - Added a warning to update_password's on_new_username option if
+        multiple accounts with the same username but different passwords exist (https://github.com/ansible-collections/community.mysql/pull/642).
+      - mysql_user - Fix ``tls_requires`` not removing ``SSL`` and ``X509`` when sets
+        as empty (https://github.com/ansible-collections/community.mysql/pull/628).
+      - mysql_user - Fix idempotence when using variables from the ``users_info``
+        filter of ``mysql_info`` as an input (https://github.com/ansible-collections/community.mysql/pull/628).
+      - mysql_user - Fixed an IndexError in the update_password functionality introduced
+        in PR https://github.com/ansible-collections/community.mysql/pull/580 and
+        released in community.mysql 3.8.0. If you used this functionality, please
+        avoid versions 3.8.0 to 3.9.0 (https://github.com/ansible-collections/community.mysql/pull/642).
+      - mysql_user - add correct ``ed25519`` auth plugin handling (https://github.com/ansible-collections/community.mysql/issues/6).
+      - mysql_variables - fix the module always changes on boolean values (https://github.com/ansible-collections/community.mysql/issues/652).
+      minor_changes:
+      - mysql_info - Add ``tls_requires`` returned value for the ``users_info`` filter
+        (https://github.com/ansible-collections/community.mysql/pull/628).
+      - mysql_info - return a database server engine used (https://github.com/ansible-collections/community.mysql/issues/644).
+      - mysql_replication - Adds support for `CHANGE REPLICATION SOURCE TO` statement
+        (https://github.com/ansible-collections/community.mysql/issues/635).
+      - mysql_replication - Adds support for `SHOW BINARY LOG STATUS` and `SHOW BINLOG
+        STATUS` on getprimary mode.
+      - 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.
+      release_summary: 'This is a minor release of the ``community.mysql`` collection.
+
+        This changelog contains all changes to the modules and plugins in this
+
+        collection that have been made after the previous release.'
+    fragments:
+    - 0-mysql_user.yml
+    - 1-mysql_info.yml
+    - 2-mysql_variables.yml
+    - 3-deprecate_mysqlclient.yml
+    - 3.10.0.yml
+    - add_salt_param_to_gen_sha256_hash.yml
+    - get_primary_show_binary_log_status.yml
+    - improve_get_replica_primary_status.yml
+    - lie_fix_mysql_user_on_new_username.yml
+    - lie_fix_plugin_hash_string_return.yml
+    - mysql_user_tls_requires.yml
+    - supports_mysql_change_replication_source_to.yml
+    release_date: '2024-08-22'
   3.2.0:
     changes:
       bugfixes:

diff --git a/changelogs/fragments/0-mysql_user.yml b/changelogs/fragments/0-mysql_user.yml
diff --git a/changelogs/fragments/1-mysql_info.yml b/changelogs/fragments/1-mysql_info.yml
diff --git a/changelogs/fragments/2-mysql_variables.yml b/changelogs/fragments/2-mysql_variables.yml
diff --git a/changelogs/fragments/3-deprecate_mysqlclient.yml b/changelogs/fragments/3-deprecate_mysqlclient.yml
diff --git a/changelogs/fragments/add_salt_param_to_gen_sha256_hash.yml b/changelogs/fragments/add_salt_param_to_gen_sha256_hash.yml
diff --git a/changelogs/fragments/get_primary_show_binary_log_status.yml b/changelogs/fragments/get_primary_show_binary_log_status.yml
diff --git a/changelogs/fragments/improve_get_replica_primary_status.yml b/changelogs/fragments/improve_get_replica_primary_status.yml
diff --git a/changelogs/fragments/lie_fix_mysql_user_on_new_username.yml b/changelogs/fragments/lie_fix_mysql_user_on_new_username.yml
diff --git a/changelogs/fragments/lie_fix_plugin_hash_string_return.yml b/changelogs/fragments/lie_fix_plugin_hash_string_return.yml
diff --git a/changelogs/fragments/mysql_user_tls_requires.yml b/changelogs/fragments/mysql_user_tls_requires.yml
diff --git a/changelogs/fragments/supports_mysql_change_replication_source_to.yml b/changelogs/fragments/supports_mysql_change_replication_source_to.yml
diff --git a/galaxy.yml b/galaxy.yml
@@ -1,7 +1,7 @@
 ---
 namespace: community
 name: mysql
-version: 3.9.0
+version: 3.10.0
 readme: README.md
 authors:
   - Ansible community