From 1776702b9d11b7d205a2ef0b1b6422b5b790c0da Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Thu, 30 Jun 2022 11:38:21 +0200 Subject: [PATCH] Announce pipefail default change in community.mysql 4.0.0 (#408) --- changelogs/fragments/2-mysql_db_announce.yml | 6 ++++++ changelogs/fragments/fix-256-mysql_dump-errors.yml | 4 ++-- plugins/modules/mysql_db.py | 5 +++-- 3 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 changelogs/fragments/2-mysql_db_announce.yml diff --git a/changelogs/fragments/2-mysql_db_announce.yml b/changelogs/fragments/2-mysql_db_announce.yml new file mode 100644 index 0000000..87d3c60 --- /dev/null +++ b/changelogs/fragments/2-mysql_db_announce.yml @@ -0,0 +1,6 @@ +--- +minor_changes: +- mysql_db - add the ``pipefail`` argument to avoid broken dumps when ``state`` is ``dump`` and compression is used (https://github.com/ansible-collections/community.mysql/issues/256). + +major_changes: +- mysql_db - the ``pipefail`` argument's default value will be changed to ``true`` in community.mysql 4.0.0. If your target machines do not use ``bash`` as a default interpreter, set ``pipefail`` to ``false`` explicitly. However, we strongly recommend setting up ``bash`` as a default and ``pipefail=true`` as it will protect you from getting broken dumps you don't know about (https://github.com/ansible-collections/community.mysql/issues/407). diff --git a/changelogs/fragments/fix-256-mysql_dump-errors.yml b/changelogs/fragments/fix-256-mysql_dump-errors.yml index 85fc0af..f3dccc0 100644 --- a/changelogs/fragments/fix-256-mysql_dump-errors.yml +++ b/changelogs/fragments/fix-256-mysql_dump-errors.yml @@ -1,7 +1,7 @@ --- bugfixes: - - mysql_dump - Fixes issue 256. Using compression masks errors messages from - mysql_dump. By default the fix is inactiv to ensure retro-compatibility + - mysql_dump - using compression masks errors messages from + mysql_dump. By default the fix is inactive to ensure retro-compatibility with system without bash. To activate the fix, use the module option ``pipefail=true`` (https://github.com/ansible-collections/community.mysql/issues/256). diff --git a/plugins/modules/mysql_db.py b/plugins/modules/mysql_db.py index 0830a12..bf681fe 100644 --- a/plugins/modules/mysql_db.py +++ b/plugins/modules/mysql_db.py @@ -159,8 +159,9 @@ options: pipefail: description: - Use C(bash) instead of C(sh) and add C(-o pipefail) to catch errors from the - mysql_dump command when I(state=import) and compression is used. The default is I(false) to - prevent issue on system without bash. The default may change in a future release. + mysql_dump command when I(state=import) and compression is used. + - The default is C(no) to prevent issues on systems without bash as a default interpreter. + - The default will change to C(yes) in community.mysql 4.0.0. type: bool default: no version_added: '3.4.0'