Skip to content

Commit

Permalink
changelogs: categorize deprecations under deprecated_features (#679)
Browse files Browse the repository at this point in the history
These should be put under deprecated_features so they show up properly
in the generated changelog.
  • Loading branch information
gotmax23 authored Sep 11, 2024
1 parent a75d71a commit 28bf709
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 28bf709

Please sign in to comment.