Add scripts for automatically updating the version of the PowerShell extension #1932

rjmholt · 2019-04-29T07:14:34Z

PR Summary

Adds scripts for:

Updating the PowerShell extension's entry in the AzureDataStudio repo
Updating the PowerShell extension's own version (allows incrementing or setting a new version)
WIP: Update PSES's version

PR Checklist

PR has a meaningful title
Summarized changes
PR has tests
This PR is ready to merge and is not work in progress
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

rjmholt · 2019-04-30T00:10:33Z

Example ADS PR: microsoft/azuredatastudio#5247

Example PSES PR: rjmholt/PowerShellEditorServices#4

Example vscode-PowerShell PR: rjmholt#6

rjmholt · 2019-04-30T03:45:27Z

One thing I'm ambivalent about is the PSES release script.

It more suitably belongs in the PSES repo, but it uses the modules in this repo. In the PowerShell repo there are build steps that download GitHub assets and it makes the build very hard to follow, reason about, debug or change and I wanted to avoid that. But philosophically PSES is its own thing.

Since we currently always release both together, I can see justification for keeping all of it in vscode-PowerShell for now, especially since it simplifies things. But I don't entirely like it either.

TylerLeonhardt · 2019-04-30T13:38:33Z

What's the reasoning for the version update scripts? So we just need to run that instead of manually sending a PR to rev the versions after a release?

tools/repoUpdateScripts/updatePsesVersions.ps1

TylerLeonhardt · 2019-04-30T20:48:33Z

tools/repoUpdateScripts/updateAzureDataStudio.ps1

+
+$repoLocation = Join-Path ([System.IO.Path]::GetTempPath()) 'ads-temp-checkout'
+
+if (-not $BranchName)


Can you put this in the default parameters?

It depends on another parameter. Does that work?

Ah, experimenting shows this depends on the order of parameters

Turns out there was complicated file-reading logic that needed to be done when $NewVersion wasn't provided, so I had to move this back out

tools/repoUpdateScripts/updateAzureDataStudio.ps1

TylerLeonhardt · 2019-04-30T21:10:44Z

tools/GitHubTools.psm1

+
+        [Parameter(Mandatory)]
+        [string]
+        $Destination,


maybe this could just have a default of "" or the current directory... or some random file directory.

"" would just error I think.

I tried to get a sensible default here, which would be the repo name, but it turns out that can be complicated

So I decided to leave it as mandatory for now, let the human figure it out

https://stackoverflow.com/questions/13839879/how-to-determine-the-humanish-part-of-a-git-repository

Looking into this

Ok I have a thing that works I think

Co-Authored-By: rjmholt <[email protected]>

rjmholt · 2019-04-30T22:55:42Z

What's the reasoning for the version update scripts? So we just need to run that instead of manually sending a PR to rev the versions after a release?

Yeah, just another component in being able to press the release button and having everything happen that needs to happen; automating the mindless without loss of oversight.

tools/GitHubTools.psm1

TylerLeonhardt · 2019-04-30T22:38:16Z

tools/FileUpdateTools.psm1

+    return $stringBuilder.ToString().Replace([System.Environment]::NewLine, "`r`n")
+}
+
+function SetFileContent


Why not use Set-Content?

Was initially to work around the UTF8 BOM thing, but I think you're right that Set-Content is best

tools/FileUpdateTools.psm1

tools/repoUpdateScripts/updateAzureDataStudio.ps1

tools/FileUpdateTools.psm1

tools/GitHubTools.psm1

TylerLeonhardt · 2019-04-30T22:46:25Z

tools/repoUpdateScripts/updateExtensionVersions.ps1

+        $MainTsContent
+    )
+
+    $pattern = [regex]'const\s+requiredEditorServicesVersion\s+=\s+"(.*)"'


I'm gonna be honest... I don't think we actually use that variable anywhere...

I doubt it too, but while it's in the code I don't want to let it rot

TylerLeonhardt · 2019-04-30T22:57:35Z

tools/repoUpdateScripts/updateExtensionVersions.ps1

+    SetFileContent -FilePath $DockerFilePath -Value $newDockerFileContent
+}
+
+function GetMarketplaceVersionFromSemVer


This looks similar to IncrementVersion - maybe worth combining somehow?

No, it converts a SemVer v2 version to what we've been using in the marketplace

Co-Authored-By: rjmholt <[email protected]>

TylerLeonhardt

LGTM + a few nits

TylerLeonhardt · 2019-05-01T23:37:47Z

tools/postReleaseScripts/updateAzureDataStudio.ps1


    # Write out the new entry
-    SetFileContent $GalleryFilePath $newGalleryFileContent
+    Set-Content -Path $GalleryFilePath -Value $newGalleryFileContent -Encoding utf8NoBOM -NoNewline


I think this means it'll only work on PS6 (utf8noBOM) - which I'm ok with for this script, but wanted to call this out

Yeah, that's right

Basically the semver handling means this will only work in PS 6, so with that in mind I've gone with a few PS6-specific things, since we can always opt for pwsh in AzDO (and unlike building, it's not important to be able to run release code in WinPS-only contexts)

Should probably add this then:

#Requires -Version 6

TylerLeonhardt · 2019-05-01T23:39:11Z

tools/postReleaseScripts/updateAzureDataStudio.ps1

nit, newline

TylerLeonhardt · 2019-05-01T23:40:13Z

tools/postReleaseScripts/updateExtensionVersions.ps1

-    $newDockerFileContent = ReplaceStringSegment -String $vstsDockerFileContent -NewSegment $Version -StartIndex $vstsDockerFileVersionSpan.Start -EndIndex $vstsDockerFileVersionSpan.End
-    SetFileContent -FilePath $DockerFilePath -Value $newDockerFileContent
+    $newDockerFileContent = New-StringWithSegment -String $vstsDockerFileContent -NewSegment $Version -StartIndex $vstsDockerFileVersionSpan.Start -EndIndex $vstsDockerFileVersionSpan.End
+    Set-Content -Path $DockerFilePath -Value $newDockerFileContent -Encoding utf8NoBOM -NoNewline


Same comment on "requiring PS6"

TylerLeonhardt · 2019-05-01T23:44:13Z

tools/postReleaseScripts/updateExtensionVersions.ps1

nit, newline

TylerLeonhardt

LGTM go ahead and do the rebase in the other PR! 👍

rjmholt added 3 commits April 29, 2019 13:24

Add AzureDataStudio update script

89898df

Copyright headers

a7e2c5d

Fix ads updater, add vsix version updater script

fe93cf2

rjmholt changed the title ~~Add scripts for automatically updating the version of the PowerShell extension~~ WIP: Add scripts for automatically updating the version of the PowerShell extension Apr 29, 2019

Improve existing scripts, add PSES update script

713ce78

rjmholt changed the title ~~WIP: Add scripts for automatically updating the version of the PowerShell extension~~ Add scripts for automatically updating the version of the PowerShell extension Apr 30, 2019

Fix param name issue

81cc2b0

TylerLeonhardt mentioned this pull request Apr 30, 2019

GitHub release script #1937

Merged

4 tasks

TylerLeonhardt reviewed Apr 30, 2019

View reviewed changes

tools/repoUpdateScripts/updatePsesVersions.ps1 Outdated Show resolved Hide resolved

TylerLeonhardt reviewed Apr 30, 2019

View reviewed changes

tools/repoUpdateScripts/updateAzureDataStudio.ps1 Outdated Show resolved Hide resolved

TylerLeonhardt reviewed Apr 30, 2019

View reviewed changes

Update tools/repoUpdateScripts/updatePsesVersions.ps1

7e0c41a

Co-Authored-By: rjmholt <[email protected]>

Simplify default parameters, move dir

82c196b

TylerLeonhardt reviewed Apr 30, 2019

View reviewed changes

TylerLeonhardt and others added 6 commits May 1, 2019 09:20

Update tools/GitHubTools.psm1

d2173cb

Co-Authored-By: rjmholt <[email protected]>

Update tools/GitHubTools.psm1

b3bf631

Co-Authored-By: rjmholt <[email protected]>

Add sensible default to repo destination

ef4eff3

Give proper names to functions

b968098

Rename functions, fix parameter problems

deb2d06

Change segment function verb

ada5b23

TylerLeonhardt approved these changes May 1, 2019

View reviewed changes

rjmholt added 2 commits May 2, 2019 10:35

Add newlines;

6507efd

Add PS 6 requirement

ecc9134

TylerLeonhardt approved these changes May 3, 2019

View reviewed changes

rjmholt merged commit 01a86e9 into PowerShell:master May 13, 2019


		$repoLocation = Join-Path ([System.IO.Path]::GetTempPath()) 'ads-temp-checkout'

		if (-not $BranchName)

Add scripts for automatically updating the version of the PowerShell extension #1932

Add scripts for automatically updating the version of the PowerShell extension #1932

Uh oh!

Conversation

rjmholt commented Apr 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

rjmholt commented Apr 30, 2019

Uh oh!

rjmholt commented Apr 30, 2019

Uh oh!

TylerLeonhardt commented Apr 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TylerLeonhardt Apr 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rjmholt commented Apr 30, 2019

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TylerLeonhardt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TylerLeonhardt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rjmholt commented Apr 29, 2019 •

edited

Loading

TylerLeonhardt commented Apr 30, 2019 •

edited

Loading

TylerLeonhardt Apr 30, 2019 •

edited

Loading