terraform/command
Martin Atkins 0fe43c8977 cli: allow disabling "next steps" message in terraform plan
In #15884 we adjusted the plan output to give an explicit command to run
to apply a plan, whereas before this command was just alluded to in the
prose.

Since releasing that, we've got good feedback that it's confusing to
include such instructions when Terraform is running in a workflow
automation tool, because such tools usually abstract away exactly what
commands are run and require users to take different actions to
proceed through the workflow.

To accommodate such environments while retaining helpful messages for
normal CLI usage, here we introduce a new environment variable
TF_IN_AUTOMATION which, when set to a non-empty value, is a hint to
Terraform that it isn't being run in an interactive command shell and
it should thus tone down the "next steps" messaging.

The documentation for this setting is included as part of the "...in
automation" guide since it's not generally useful in other cases. We also
intentionally disclaim comprehensive support for this since we want to
avoid creating an extreme number of "if running in automation..."
codepaths that would increase the testing matrix and hurt maintainability.

The focus is specifically on the output of the three commands we give in
the automation guide, which at present means the following two situations:

* "terraform init" does not include the final paragraphs that suggest
  running "terraform plan" and tell you in what situations you might need
  to re-run "terraform init".
* "terraform plan" does not include the final paragraphs that either
  warn about not specifying "-out=..." or instruct to run
  "terraform apply" with the generated plan file.
2017-09-14 10:51:41 -07:00
..
clistate Have the clistate Lock use LockWithContext 2017-04-01 17:09:20 -04:00
e2etest Use t.Helper() in our test helpers 2017-08-28 09:59:30 -07:00
format command/format: restore "(forces new resource)" caption 2017-09-11 12:55:32 -07:00
test-fixtures command/validate: read terraform.tfvars file for variable values 2017-08-28 12:01:11 -07:00
testdata Have backend operations properly unlock state 2017-02-15 14:41:55 -05:00
apply.go Autoload only .auto.tfvars files 2017-07-05 17:24:17 -07:00
apply_destroy_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
apply_test.go add some Serial checks to apply and refresh tests 2017-07-05 18:18:28 -04:00
cli_ui.go adding new AskSecret to ColorizeUi 2015-04-29 13:07:13 -05:00
cli_ui_test.go command/*: colors on error messages (red) 2014-07-12 20:59:16 -07:00
command.go always pass in the full plugin path to dicovery 2017-06-16 14:09:47 -04:00
command_test.go Use t.Helper() in our test helpers 2017-08-28 09:59:30 -07:00
console.go Autoload only .auto.tfvars files 2017-07-05 17:24:17 -07:00
console_interactive.go command: split out and tag code so compilation works on Solaris 2016-11-14 00:32:01 -08:00
console_interactive_solaris.go command: split out and tag code so compilation works on Solaris 2016-11-14 00:32:01 -08:00
console_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
debug_command.go Add debug command with json2dot 2016-11-21 11:59:20 -05:00
debug_json2dot.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
debug_json2dot_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
flag_kv.go command: use helper/variables for flags and parsing 2016-12-10 14:30:40 -05:00
flag_kv_test.go command: use helper/variables for flags and parsing 2016-12-10 14:30:40 -05:00
fmt.go command: add -check flag to fmt (#15304) 2017-07-21 14:37:15 -05:00
fmt_test.go command: add -check flag to fmt (#15304) 2017-07-21 14:37:15 -05:00
get.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
get_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
graph.go graph should not panic with no config 2017-07-18 13:03:57 -04:00
graph_test.go graph should not panic with no config 2017-07-18 13:03:57 -04:00
hcl_printer.go always quote hcl map keys 2017-02-24 18:32:59 -05:00
hcl_printer_test.go always quote hcl map keys 2017-02-24 18:32:59 -05:00
hook_ui.go command: show resource actions using resource addresses 2017-09-01 17:55:05 -07:00
hook_ui_test.go Output duration in UiHook after successful operation completion. 2017-08-16 14:41:41 -07:00
import.go update import command docs 2017-08-09 14:01:45 -04:00
import_test.go Don't ForceLocal for the import backend 2017-08-09 10:24:32 -04:00
init.go cli: allow disabling "next steps" message in terraform plan 2017-09-14 10:51:41 -07:00
init_test.go command/init: check required_version 2017-08-28 11:25:16 -07:00
internal_plugin.go Set a log prefix for each plugin and remove go-dynect global log prefix (#6336) 2016-05-10 14:49:13 -04:00
internal_plugin_list.go Add salt-masterless provisioner 2017-08-07 10:00:29 -04:00
internal_plugin_test.go Add salt-masterless provisioner 2017-08-07 10:00:29 -04:00
meta.go cli: allow disabling "next steps" message in terraform plan 2017-09-14 10:51:41 -07:00
meta_backend.go cli: allow disabling "next steps" message in terraform plan 2017-09-14 10:51:41 -07:00
meta_backend_migrate.go command + backend: rename various API objects to "Workspace" terminology 2017-06-09 16:26:25 -07:00
meta_backend_test.go command + backend: rename various API objects to "Workspace" terminology 2017-06-09 16:26:25 -07:00
meta_new.go have Meta.Backend use a Config rather than loading 2017-06-09 14:03:59 -07:00
meta_test.go properly cleanup and print correct error messages 2017-07-06 11:33:32 -04:00
module_storage.go fix a bunch of tests from go-getter import 2015-10-15 13:48:58 -07:00
module_storage_test.go fix a bunch of tests from go-getter import 2015-10-15 13:48:58 -07:00
output.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
output_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
plan.go Autoload only .auto.tfvars files 2017-07-05 17:24:17 -07:00
plan_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
plugins.go load Meta.PluginOverrides in dicovery 2017-08-09 11:14:33 -04:00
plugins_lock.go change providers.json to lock.json 2017-06-09 14:03:59 -07:00
plugins_lock_test.go command: helper to manage the provider plugins lock file 2017-06-09 14:03:59 -07:00
plugins_test.go Fix swallowed errors in command package. 2017-07-11 08:01:02 -07:00
providers.go command/providers: Enable processing of meta-parameters 2017-06-10 11:51:06 +01:00
providers_test.go command/providers: Add regression test 2017-06-10 12:02:01 +01:00
push.go Autoload only .auto.tfvars files 2017-07-05 17:24:17 -07:00
push_test.go Don't show plugin init message if there are none 2017-06-19 12:08:42 -04:00
refresh.go Autoload only .auto.tfvars files 2017-07-05 17:24:17 -07:00
refresh_test.go add some Serial checks to apply and refresh tests 2017-07-05 18:18:28 -04:00
show.go command/format: improve consistency of plan results 2017-09-01 17:55:05 -07:00
show_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
state_command.go Thread the environment through all commands 2017-02-28 16:35:46 -05:00
state_list.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
state_list_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
state_meta.go Make the state commands use the real command.Meta 2017-07-27 15:33:50 -04:00
state_mv.go update state rm amd mv docs 2017-08-03 13:24:23 -04:00
state_mv_test.go add tests for state commands through a backend 2017-07-27 18:06:47 -04:00
state_pull.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
state_pull_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
state_push.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
state_push_test.go create failing test cases for remote lineage issue 2017-08-01 19:34:21 -04:00
state_rm.go make state_rm flag description match state_mv 2017-08-09 14:03:40 -04:00
state_rm_test.go add tests for state commands through a backend 2017-07-27 18:06:47 -04:00
state_show.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
state_show_test.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
state_test.go Make the state commands use the real command.Meta 2017-07-27 15:33:50 -04:00
taint.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
taint_test.go Clean up LockInfo and LockError and use them 2017-02-15 14:44:43 -05:00
ui_input.go command: initial work on migrating envs, basic cases first 2017-03-01 10:59:17 -08:00
ui_input_test.go command: use bufio.ReadString instead of scanning to get spaces 2016-08-22 12:59:48 -07:00
unlock.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
unlock_test.go create failing test cases for remote lineage issue 2017-08-01 19:34:21 -04:00
untaint.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
untaint_test.go Clean up LockInfo and LockError and use them 2017-02-15 14:44:43 -05:00
validate.go command/validate: read terraform.tfvars file for variable values 2017-08-28 12:01:11 -07:00
validate_test.go command/validate: read terraform.tfvars file for variable values 2017-08-28 12:01:11 -07:00
version.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
version_test.go Implement CLI, version command 2014-05-24 12:04:43 -07:00
workspace_command.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
workspace_command_test.go update workspace new test for inmem backend 2017-08-01 19:34:22 -04:00
workspace_delete.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
workspace_list.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
workspace_new.go Return immediately after newly-added error condition 2017-07-19 15:46:21 -07:00
workspace_select.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00
workspace_show.go Use all tfvars files in working directory 2017-07-05 17:24:17 -07:00