update help text for hcl2_upgrade (#10624)

This commit is contained in:
Megan Marsh 2021-02-15 02:03:44 -08:00 committed by GitHub
parent 80ed988ffe
commit cac6b04546
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions

View File

@ -554,9 +554,18 @@ func isSensitiveVariable(key string, vars []*template.Variable) bool {
func (*HCL2UpgradeCommand) Help() string { func (*HCL2UpgradeCommand) Help() string {
helpText := ` helpText := `
Usage: packer hcl2_upgrade -output-file=JSON_TEMPLATE.pkr.hcl JSON_TEMPLATE... Usage: packer hcl2_upgrade [options] TEMPLATE
Will transform your JSON template into an HCL2 configuration. Will transform your JSON template into an HCL2 configuration.
Options:
-output-file=path Set output file name. By default this will be the
TEMPLATE name with ".pkr.hcl" appended to it. To be a
valid Packer HCL template, it must have the suffix
".pkr.hcl"
-with-annotations Add helper annotation comments to the file to help new
HCL2 users understand the template format.
` `
return strings.TrimSpace(helpText) return strings.TrimSpace(helpText)