A software delivery pipeline starts with a build. A build creates the artifacts you need. You then use these artifacts to deploy to different environments while only changing the configuration data that’s specific for an environment.
When it comes to Visual Studio Team Services extensions, the artifact that gets created by your build is a VSIX package. A VSIX is a ZIP file that contains metadata on your extension and the actual files required for your extension. There is no official way to edit a VSIX file after it’s been created. But when deploying a VSIX to different environments I want to be able to change things like the Publisher ID and the Version number. This allows me to have a single package and change the configuration data on deployment.
Manipulating a VSIX with PowerShell
Fortunately, the .NET Framework has support for manipulating the files in a ZIP file. The following script takes a VSIX, opens it up and updates values before publishing it to VSTS.
[cmdletbinding()]
param(
[string] [Parameter(Mandatory=$true)] $PathToVSIX,
[string] [Parameter(Mandatory=$true)] $Token,
[string] $IsPublicInput = "false",
[string] $Version = $null,
[string] $Publisher = $null,
[string] $RemoveBaseUriInput = "true",
[string] $ShareWith= $null
)
Set-StrictMode -Version 3
[bool]$IsPublic = [bool]::Parse($IsPublicInput)
[bool]$RemoveBaseUri = [bool]::Parse($RemoveBaseUriInput)
$file = Get-ChildItem $PathToVSIX -Filter *.vsix -Recurse | % { $_.FullName } | Select -First 1
Write-Verbose "Found VSIX Package $file"
try { $null = [IO.Compression.ZipFile] }
catch { [System.Reflection.Assembly]::LoadWithPartialName('System.IO.Compression.FileSystem') }
try { $fileZip = [System.IO.Compression.ZipFile]::Open( $file, 'Update' ) }
catch { throw "Another process has locked the '$file' file." }
$desiredFile = [System.IO.StreamReader]($fileZip.Entries | Where-Object { $_.FullName -match 'extension.vsixmanifest' }).Open()
$text = $desiredFile.ReadToEnd()
[xml]$xml = $text
$desiredFile.Close()
$desiredFile.Dispose()
if ($Version)
{
Write-Verbose "Updating Version to $Version"
$xml.PackageManifest.MetaData.Identity.Version = $Version
}
if ($Publisher)
{
Write-Verbose "Updating Publisher to $Publisher"
$xml.PackageManifest.MetaData.Identity.Publisher = $Publisher
}
if($IsPublic -eq $true)
{
Write-Verbose "Setting GalleryFlag to Public"
$xml.PackageManifest.MetaData.GalleryFlags = "Public"
}
else
{
Write-Verbose "Setting GalleryFlag to Private"
$xml.PackageManifest.MetaData.GalleryFlags = ""
}
$desiredFile = [System.IO.StreamWriter]($fileZip.Entries | Where-Object { $_.FullName -match 'extension.vsixmanifest' }).Open()
$desiredFile.BaseStream.SetLength(0)
$desiredFile.Write($xml.InnerXml)
$desiredFile.Flush()
$desiredFile.Close()
$desiredFile = [System.IO.StreamReader]($fileZip.Entries | Where-Object { $_.FullName -match 'extension.vsomanifest' }).Open()
$text = $desiredFile.ReadToEnd()
$desiredFile.Close()
$desiredFile.Dispose()
if ($RemoveBaseUri -eq $true)
{
$text = (($text -split "`n") | ? {$_ -notmatch 'baseUri'}) -join "`n"
}
$desiredFile = [System.IO.StreamWriter]($fileZip.Entries | Where-Object { $_.FullName -match 'extension.vsomanifest' }).Open()
$desiredFile.BaseStream.SetLength(0)
$desiredFile.Write($text)
$desiredFile.Flush()
$desiredFile.Close()
$fileZip.Dispose()
if($ShareWith -ne $null)
{
$ShareWith = "--share-with" + $ShareWith
}
else
{
$ShareWith = ""
}
npm install -g tfx-cli
tfx extension publish --vsix "$File" --token $Token $ShareWith
You can use this PowerShell script and execute it as a step in your release definition to configure and publish your extension.