Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove old Update-Change-Log.ps1 #1301

Merged
merged 1 commit into from
Jan 7, 2021
Merged

Remove old Update-Change-Log.ps1 #1301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 0 additions & 153 deletions eng/common/Update-Change-Log.ps1
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions eng/common/scripts/Update-ChangeLog.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ param (
[String]$ServiceDirectory,
[Parameter(Mandatory = $true)]
[String]$PackageName,
[String]$Unreleased=$True,
[String]$ReplaceLatestEntryTitle = $False,
[String]$Unreleased = "true", #Argument is string becasue of the different ways the script is called in the various repos.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious about this, why can't you do this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is because of how the script is called here. PowerShell in converting to Boolean results in true for both "true" and "false"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd normally use a [switch] type for this kinds of options in PowerShell, example:

function Do-Stuff
{
  param(
    [switch]$FooSwitch
  )

  Write-Host $FooSwitch
}

When you invoke this function you can do this:

Do-Stuff
Output: False

Do-Stuff -FooSwitch
Output: True

Do-Stuff -FooSwtich:$false
Output: False

Do-Stuff -FooSwitch:$([System.Boolean]::Parse("false"))
Output: False

Do-Stuff -FooSwitch:$([System.Boolean]::Parse("true"))
Output: True

In short PowerShell provides the mechanisms to declare these kinds of switches and pass in true-false values.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see.
Do you know how the switch will be invoked from JS

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I expect the switch to work fine from anywhere (Note that -FooSwitch:0/1 also works). The key with using a switch is to use a term that means the variable defaults to false and so folks will only ever pass it if they want to set it to true.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the array that is passed into the spawn command is just the argument list. But it looks like pwsh.exe has a nice little affordance where you can invoke it like this:

pwsh.exe [script] [args]

For example:

pwsh.exe Do-Stuff.ps1 -FooSwitch:false

(note you don't need to do the [System.Boolean] thing.

Copy link
Member Author

@chidozieononiwu chidozieononiwu Jan 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weshaggard Unfortunately -FooSwitch:0/1 does not work. This does work though -FooSwitch:$true

[String]$ReplaceLatestEntryTitle = "false",
[String]$ReleaseDate
)

Expand All @@ -23,7 +23,7 @@ param (
. (Join-Path $PSScriptRoot common.ps1)

if ($ReleaseDate -and $Unreleased) {
LogError "Do not pass 'ReleaseDate' arguement when 'Unreleased' is true"
LogError "Do not pass 'ReleaseDate' argument when 'Unreleased' is true"
exit 1
}

Expand Down