From 26005dfa5beef98948fbb66ce90c68b89f17247a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Moser?= Date: Wed, 2 Mar 2016 11:09:47 +0100 Subject: [PATCH] proposal: deprecate always_run in favor of checkmode_run --- docs/proposals/rename_always_run.md | 34 +++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/proposals/rename_always_run.md diff --git a/docs/proposals/rename_always_run.md b/docs/proposals/rename_always_run.md new file mode 100644 index 00000000000..6adcd508f49 --- /dev/null +++ b/docs/proposals/rename_always_run.md @@ -0,0 +1,34 @@ +# Rename always_run to checkmode_run + +*Author*: René Moser <@resmo> + +*Date*: 02/03/2016 + +## Motivation + +The task argument `always_run` is misleading. + +Ansible is known to be readable by users without deep knowledge of creating playbooks, they do not understand +what `always_run` does at the first glance. + +### Problems + +The following looks scary if you have no idea, what `always_run` does: + +``` +- shell: dangerous_cleanup.sh + when: cleanup == "yes" + always_run: yes +``` + +You have a conditional but also a word that says `always`. This is a conflict in terms of understanding. + +## Solution Proposal + +Deprecate `always_run` by rename it to `checkmode_run`: + +``` +- shell: dangerous_cleanup.sh + when: cleanup == "yes" + checkmode_run: yes +```