As we know, JSON does not allow comments, and only root level comments are 
valid in a template. 

If there was a Description key, that doesn't do much beyond validating 
correctly, it would be a fantastic place to comment each step of the 
template. This becomes especially useful if you have a lot of provisioning 
steps, or have steps for workarounds, or steps of non-obvious intent. 

Example from the tutorial

{
  "variables": ["..."],
  "builders": ["..."],

  "provisioners": [{
    "description": "Install latest Redis version; WARNING: This may conflict 
with foo",
    "type": "shell",
    "inline": [
      "sleep 30",
      "sudo apt-get update",
      "sudo apt-get install -y redis-server"
    ]
  }]}

-- 
This mailing list is governed under the HashiCorp Community Guidelines - 
https://www.hashicorp.com/community-guidelines.html. Behavior in violation of 
those guidelines may result in your removal from this mailing list.

GitHub Issues: https://github.com/mitchellh/packer/issues
IRC: #packer-tool on Freenode
--- 
You received this message because you are subscribed to the Google Groups 
"Packer" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/packer-tool/4db72b1a-2894-40d0-a617-4d6f49ed27e3%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to