remove clean_ami_name and clean_image_name; complete the deprecation for these functions in favor of clean_resource_name

This commit is contained in:
Megan Marsh 2019-10-03 15:48:17 -07:00
parent 928c6a3615
commit 0026792d2f
4 changed files with 10 additions and 10 deletions

View File

@ -39,5 +39,4 @@ func templateCleanAMIName(s string) string {
var TemplateFuncs = template.FuncMap{ var TemplateFuncs = template.FuncMap{
"clean_resource_name": templateCleanAMIName, "clean_resource_name": templateCleanAMIName,
"clean_ami_name": packertpl.DeprecatedTemplateFunc("clean_ami_name", "clean_resource_name", templateCleanAMIName),
} }

View File

@ -39,5 +39,4 @@ func templateCleanImageName(s string) string {
var TemplateFuncs = template.FuncMap{ var TemplateFuncs = template.FuncMap{
"clean_resource_name": templateCleanImageName, "clean_resource_name": templateCleanImageName,
"clean_image_name": packertpl.DeprecatedTemplateFunc("clean_image_name", "clean_resource_name", templateCleanImageName),
} }

View File

@ -37,5 +37,4 @@ func templateCleanImageName(s string) string {
var TemplateFuncs = template.FuncMap{ var TemplateFuncs = template.FuncMap{
"clean_resource_name": templateCleanImageName, "clean_resource_name": templateCleanImageName,
"clean_image_name": packertpl.DeprecatedTemplateFunc("clean_image_name", "clean_resource_name", templateCleanImageName),
} }

View File

@ -41,7 +41,7 @@ Here is a full list of the available functions for reference.
will convert upper cases to lower cases and replace illegal characters with will convert upper cases to lower cases and replace illegal characters with
a "-" character. Example: a "-" character. Example:
`"mybuild-{{isotime | clean_image_name}}"` will become `"mybuild-{{isotime | clean_resource_name}}"` will become
`mybuild-2017-10-18t02-06-30z`. `mybuild-2017-10-18t02-06-30z`.
Note: Valid Azure image names must match the regex Note: Valid Azure image names must match the regex
@ -57,6 +57,9 @@ Here is a full list of the available functions for reference.
clean_resource_name}}"` will cause your build to fail because the image clean_resource_name}}"` will cause your build to fail because the image
name will start with a number, which is why in the above example we prepend name will start with a number, which is why in the above example we prepend
the isotime with "mybuild". the isotime with "mybuild".
Exact behavior of `clean_resource_name` will depend on which builder it is
being applied to; refer to build-specific docs below for more detail on how
each function will behave.
- `env` - Returns environment variables. See example in [using home - `env` - Returns environment variables. See example in [using home
variable](/docs/templates/user-variables.html#using-home-variable) variable](/docs/templates/user-variables.html#using-home-variable)
- `isotime [FORMAT]` - UTC time, which can be - `isotime [FORMAT]` - UTC time, which can be
@ -80,19 +83,19 @@ Here is a full list of the available functions for reference.
#### Specific to Amazon builders: #### Specific to Amazon builders:
- `clean_ami_name` - DEPRECATED use `clean_resource_name` instead - AMI names - `clean_resource_name` - AMI names
can only contain certain characters. This function will replace illegal can only contain certain characters. This function will replace illegal
characters with a '-" character. Example usage since ":" is not a legal AMI characters with a '-" character. Example usage since ":" is not a legal AMI
name is: `{{isotime | clean_ami_name}}`. name is: `{{isotime | clean_resource_name}}`.
#### Specific to Google Compute builders: #### Specific to Google Compute builders:
- `clean_image_name` - DEPRECATED use `clean_resource_name` instead - GCE - `clean_resource_name` - GCE
image names can only contain certain characters and the maximum length is image names can only contain certain characters and the maximum length is
63. This function will convert upper cases to lower cases and replace 63. This function will convert upper cases to lower cases and replace
illegal characters with a "-" character. Example: illegal characters with a "-" character. Example:
`"mybuild-{{isotime | clean_image_name}}"` will become `"mybuild-{{isotime | clean_resource_name}}"` will become
`mybuild-2017-10-18t02-06-30z`. `mybuild-2017-10-18t02-06-30z`.
Note: Valid GCE image names must match the regex Note: Valid GCE image names must match the regex
@ -107,12 +110,12 @@ Here is a full list of the available functions for reference.
#### Specific to Azure builders: #### Specific to Azure builders:
- `clean_image_name` - DEPRECATED use `clean_resource_name` instead - Azure - `clean_resource_name` - Azure
managed image names can only contain certain characters and the maximum managed image names can only contain certain characters and the maximum
length is 80. This function will replace illegal characters with a "-" length is 80. This function will replace illegal characters with a "-"
character. Example: character. Example:
`"mybuild-{{isotime | clean_image_name}}"` will become `"mybuild-{{isotime | clean_resource_name}}"` will become
`mybuild-2017-10-18t02-06-30z`. `mybuild-2017-10-18t02-06-30z`.
Note: Valid Azure image names must match the regex Note: Valid Azure image names must match the regex