diff --git a/Scripts/Install-NewestPackage.ps1 b/Scripts/Install-NewestPackage.ps1 index 8e492636e514d2a1a6462af59cba36e2ba5d4b84..2dc864c0b219d2d6fe70eb6b7e4e3857123a5367 100644 --- a/Scripts/Install-NewestPackage.ps1 +++ b/Scripts/Install-NewestPackage.ps1 @@ -1,3 +1,7 @@ +# Helper script to locate the latest AutoTx installation package (expected to be +# in a subdirectory of this script with a name like `build_2019-04-23_12-34-56`) +# and call the installer script from *within* that package. + # Make sure to run from the directory containing the script itself: $BaseDir = $(Split-Path $MyInvocation.MyCommand.Path) Push-Location $BaseDir diff --git a/Scripts/Install-Service.ps1 b/Scripts/Install-Service.ps1 index 5664f87a29b0295dc4032545964dae295bf9c8db..26bf47b561001b0d852d28dc058f390bfc569244 100644 --- a/Scripts/Install-Service.ps1 +++ b/Scripts/Install-Service.ps1 @@ -1,4 +1,8 @@ -# helper script to install the AutoTx service on a computer +# Helper script to install the AutoTx service on a computer. It is intended to +# be run from *within* an AutoTx installation package created with the +# `Make-Package.ps1` script. +# +# NOTE: the script will NOT update an existing installation of AutoTx! # set our requirements: #Requires -version 5.1 diff --git a/Scripts/Make-Package.ps1 b/Scripts/Make-Package.ps1 index c74dd402ec229bfb6b831ed9a8f819a53a1d4c43..08434921b43e5e0428b412afd43a83f114c10cb2 100644 --- a/Scripts/Make-Package.ps1 +++ b/Scripts/Make-Package.ps1 @@ -1,5 +1,5 @@ -# helper script to create a package from an AutoTx build that can be used from -# the included "Install-Service.ps1" script as well as with the AutoTx-Updater +# Helper script to create a package from an AutoTx build that can be used from +# the included `Install-Service.ps1` script as well as with the AutoTx-Updater. # set our requirements: #Requires -version 5.1 diff --git a/Scripts/Prepare-Build.ps1 b/Scripts/Prepare-Build.ps1 index 05ce5a1a17d1d5ae8183d7a138895bf6506b4ca0..a360ab89364b996d322cc2d9f9c8fb1b0a8ac405 100644 --- a/Scripts/Prepare-Build.ps1 +++ b/Scripts/Prepare-Build.ps1 @@ -1,3 +1,5 @@ +# Helper script to be called by Visual Studio as a "pre-build" command. + [CmdletBinding(DefaultParameterSetName="build")] Param( [Parameter(Mandatory=$True, ParameterSetName="build")] diff --git a/Scripts/Provide-UpdaterPackage.ps1 b/Scripts/Provide-UpdaterPackage.ps1 index dfb7f2055cb16227a53617f67b8e1a879aba3386..0c337980bb9389d00ab16b33ef088fcda17ae2f1 100644 --- a/Scripts/Provide-UpdaterPackage.ps1 +++ b/Scripts/Provide-UpdaterPackage.ps1 @@ -1,3 +1,13 @@ +# Helper script to locate the latest AutoTx installation package (expected to be +# in a subdirectory of this script with a name like `build_2019-04-23_12-34-56`) +# and copy it to the correct path so it can be picked up the AutoTx-Updater. +# +# NOTE: the script will prune a few files (currently hardcoded) from the package +# copied to the central update location to prevent sensitive information from +# being accidentially leaked through a publicly accessible location (see the +# `$Exclude` variable below). + + [CmdletBinding()] Param( [Parameter(Mandatory=$True)][String] $UpdaterSettings