Update-Script File Info

Module:
PowerShellGet
Updates information for a script.

Syntax 

Update-ScriptFileInfo
      [-Path] <String>
      [-Version <Version>]
      [-Author <String>]
      [-Guid <Guid>]
      [-Description <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-RequiredModules <Object[]>]
      [-ExternalModuleDependencies <String[]>]
      [-RequiredScripts <String[]>]
      [-ExternalScriptDependencies <String[]>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String[]>]
      [-PassThru]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-ScriptFileInfo
      [-LiteralPath] <String>
      [-Version <Version>]
      [-Author <String>]
      [-Guid <Guid>]
      [-Description <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-RequiredModules <Object[]>]
      [-ExternalModuleDependencies <String[]>]
      [-RequiredScripts <String[]>]
      [-ExternalScriptDependencies <String[]>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String[]>]
      [-PassThru]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-ScriptFileInfo cmdlet updates information for a script.

Examples

Example 1: Update the version of a script file 

PS C:\> New-ScriptFileInfo -Path "\temp\temp-scriptfile.ps1" -Version 1.0 -Author "pattif@contoso.com" -Description "my test script file description goes here"

PS C:\> Test-ScriptFileInfo -Path "\temp\temp-scriptfile.ps1"

Version    Name                      Author               Description

-------    ----                      ------               -----------

1.0        temp-scriptfile           manikb@microsoft.com my test script file description goes here PS C:\> Update-ScriptFileInfo -Path "\temp\temp-scriptfile.ps1" -Version 2.0 -PassThru

<#PSScriptInfo



.VERSION 2.0

.GUID eb246b19-17da-4392-8c89-7c280f69ad0e

.AUTHOR manikb@microsoft.com

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES



.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES



#>

<#

.DESCRIPTION

 my test script file description goes here

#>

Param()

The first command creates a script file and assigns it version 1.0.

The second command uses the Test-ScriptFileInfo cmdlet to validate temp-scriptfile.ps1 and display the results.

The third command uses Update-ScriptFileInfo to update the version number to 2.0.

Required Parameters

-LiteralPath

Specifies a path to one or more locations. Unlike the Path parameter, the value of the LiteralPath parameter is used exactly as it is entered. No characters are interpreted as wildcards. If the path includes escape characters, enclose them in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.

Type: String
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Path

Specifies a path to one or more locations. Wildcards are permitted. The default location is the current directory (.).

Type: String
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-Author

Specifies the script author.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompanyName

Specifies the company or vendor who created the script.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Copyright

Specifies a copyright statement for the script.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description

Specifies a description for the script.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExternalModuleDependencies

Specifies an array of external module dependencies.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExternalScriptDependencies

Specifies an array of external script dependencies.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Guid

Specifies a unique ID for a script.

Type: Guid
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IconUri

Specifies the URL of an icon for the script. The specified icon is displayed on the gallery web page for the script.

Type: Uri
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LicenseUri

Specifies the URL of licensing terms.

Type: Uri
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProjectUri

Specifies the URL of a web page about this project.

Type: Uri
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReleaseNotes

Specifies a string array that contains release notes or comments that you want to be available to users for this version of the script.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequiredModules

Specifies modules that must be in the global session state. If the required modules are not in the global session state, Windows PowerShell imports them.

Type: Object[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequiredScripts

Specifies an array of required scripts.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags

Specifies an array of tags.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Version

Specifies the version of the script.

Type: Version
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False