Merge branch 'stable'

* stable: (doc) Get-PackageParameters - fix example (GH-1476) Ensure docs are for Get-PackageParameters (doc) update generated docs (doc) update release notes for 0.10.9 (GH-1517) Fix: Given path's format is not supported (doc)(maint) CHANGELOG formatting (doc) update licensed CHANGELOG
chocolatey · Mar 23, 2018 · c430da2 · c430da2
2 parents 1999086 + 47ec81c
commit c430da2
Show file tree

Hide file tree

Showing 38 changed files with 409 additions and 396 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CHANGELOG_LICENSED.md b/CHANGELOG_LICENSED.md
@@ -4,6 +4,39 @@ This covers changes for the "chocolatey.extension" package, where the licensed e
 
 **NOTE**: If you have a licensed edition of Chocolatey, refer to this in tandem with [Chocolatey Open source CHANGELOG](https://github.com/chocolatey/choco/blob/master/CHANGELOG.md).
 
+## 1.12.11 (February 1, 2018)
+
+**NOTE**: We've identified an issue with Self-Service interactive and UAC - we are working on a fix. Please see [#36](https://github.com/chocolatey/chocolatey-licensed-issues/issues/36) and subscribe for details.
+
+A few nice things going into this release with Package Reducer/Optimize coming out of preview, Package Internalizer allowing you to specify variable overrides
+
+### BREAKING CHANGES
+
+ * Package Reducer is now on by default
+
+When we first released package reducer, it was in a preview mode to allow for folks to opt in to test it and find issues. Now we are turning it on by default. If you should experience issues with it, please contact support to file an issue (provide a zipped log as well). To turn it off should you not want to use it, you can just run `choco feature disable --name=reduceInstalledPackageSpaceUsage`.
+
+### BUG FIXES
+
+ * Self-Service / Background Mode:
+    * Fix - Work with empty sessions. Self-service users were incorrectly bypassing background service when their active session doesn't have a name, which has become common with Windows 10.
+    * Fix - Allow self-service to work when the current working directory is different from system drive or a mapped drive. Also allow it to be set to locations where any user would not have a permissions error.
+ * Package Internalizer (Choco Download):
+    * Fix - When a variable is set to the contents of a file, work with that appropriately. A good example of this is `$data` variable in [dotnetcore-runtime](https://github.com/dotnetcore-chocolatey/dotnetcore-chocolateypackages/blob/d5960c11dda388cc7f7ab6438eee8984774f7662/dotnetcore-runtime.install/tools/ChocolateyInstall.ps1#L4) package.
+    * Fix - Allow setting variable when there is a comment on the same line following the set. An example of this is in the [Firefox](https://github.com/chocolatey/chocolatey-coreteampackages/blob/91f4e51f5c8503ca962c22a2f087b96d22ae0e9f/automatic/firefox/tools/chocolateyInstall.ps1#L26) package.
+ * Package Builder (Choco New):
+    * Fix - Package Builder UI should recognize Architect and MSP editions and correctly set the UI for use with them.
+    * Fix - Extract icon from the proper location for the file.
+
+### IMPROVEMENTS
+
+ * Package Internalizer (Choco Download):
+    * Override variables in the installation script. When you see something like `$locale` being set and you want to override it to your own value for internalization, you can pass that variable name and value as a key value pair. As an example, try `choco download thunderbird --internalize locale=en-US` versus `choco download thunderbird --internalize locale=es-ES`.
+ * Package Reducer - `choco optimize` command out of preview.
+ * Package Builder (Choco New):
+    * Extract icons from MSIs as well.
+    * Package Builder UI logo animzation should match chocolatey website.
+
 ## 1.12.10 (December 18, 2017)
 
 ### FEATURES

diff --git a/GenerateDocs.ps1 b/GenerateDocs.ps1
@@ -283,6 +283,11 @@ try
   Write-Host "Importing the Module $psModuleName ..."
   Import-Module "$psModuleLocation" -Force -Verbose
 
+  # Switch Get-PackageParameters back for documentation
+  Remove-Item alias:Get-PackageParameters
+  Remove-Item function:Get-PackageParametersBuiltIn
+  Set-Alias -Name Get-PackageParametersBuiltIn -Value Get-PackageParameters -Scope Global
+
   if (Test-Path($docsFolder)) { Remove-Item $docsFolder -Force -Recurse -EA SilentlyContinue }
   if(-not(Test-Path $docsFolder)){ mkdir $docsFolder -EA Continue | Out-Null }
 

diff --git a/docs/generated/CommandsApiKey.md b/docs/generated/CommandsApiKey.md
@@ -72,6 +72,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsConfig.md b/docs/generated/CommandsConfig.md
@@ -56,6 +56,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsDownload.md b/docs/generated/CommandsDownload.md
@@ -70,6 +70,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsFeature.md b/docs/generated/CommandsFeature.md
@@ -42,6 +42,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsFeatures.md b/docs/generated/CommandsFeatures.md
@@ -42,6 +42,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsInfo.md b/docs/generated/CommandsInfo.md
@@ -35,6 +35,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsInstall.md b/docs/generated/CommandsInstall.md
@@ -173,6 +173,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsList.md b/docs/generated/CommandsList.md
@@ -75,6 +75,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsNew.md b/docs/generated/CommandsNew.md
@@ -81,6 +81,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsOptimize.md b/docs/generated/CommandsOptimize.md
@@ -67,6 +67,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsOutdated.md b/docs/generated/CommandsOutdated.md
@@ -53,6 +53,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsPack.md b/docs/generated/CommandsPack.md
@@ -57,6 +57,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsPin.md b/docs/generated/CommandsPin.md
@@ -48,6 +48,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsPush.md b/docs/generated/CommandsPush.md
@@ -74,6 +74,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsReference.md b/docs/generated/CommandsReference.md
@@ -104,6 +104,10 @@ You can pass options and switches in the following ways:
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsSearch.md b/docs/generated/CommandsSearch.md
@@ -75,6 +75,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsSetapiKey.md b/docs/generated/CommandsSetapiKey.md
@@ -72,6 +72,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsSource.md b/docs/generated/CommandsSource.md
@@ -59,6 +59,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsSources.md b/docs/generated/CommandsSources.md
@@ -59,6 +59,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsSupport.md b/docs/generated/CommandsSupport.md
@@ -23,6 +23,10 @@ As a licensed customer, you can reach out to
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsSync.md b/docs/generated/CommandsSync.md
@@ -58,6 +58,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsSynchronize.md b/docs/generated/CommandsSynchronize.md
@@ -58,6 +58,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsUninstall.md b/docs/generated/CommandsUninstall.md
@@ -102,6 +102,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsUnpackself.md b/docs/generated/CommandsUnpackself.md
@@ -2,11 +2,11 @@
 
 # UnpackSelf Command (choco unpackself)
 
-This will unpack files needed by choco. It will overwrite existing 
+This will unpack files needed by choco. It will overwrite existing
  files only if --force is specified.
 
-**NOTE:** This command should only be used when installing Chocolatey, not 
- during normal operation. 
+**NOTE:** This command should only be used when installing Chocolatey, not
+ during normal operation.
 
 
 ## Options and Switches
@@ -36,6 +36,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsUpdate.md b/docs/generated/CommandsUpdate.md
@@ -33,6 +33,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsUpgrade.md b/docs/generated/CommandsUpgrade.md
@@ -72,6 +72,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/CommandsVersion.md b/docs/generated/CommandsVersion.md
@@ -37,6 +37,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/docs/generated/HelpersGetPackageParameters.md b/docs/generated/HelpersGetPackageParameters.md
@@ -42,7 +42,8 @@ build all docs with `/Item:Value`.
 
 ## Aliases
 
-None
+`Get-PackageParametersBuiltIn`
+
 
 ## Examples
 
@@ -77,8 +78,9 @@ if (!$pp['LICENSE']) { $pp['LICENSE'] = '1234' }
 ~~~powershell
 
 $pp = Get-PackageParameters
-# Requires 0.10.8 for Read-Host -AsSecureString
-if (!$pp['Password']) { $pp['Password'] = Read-Host "Enter password for $userName:" -AsSecureString}
+if (!$pp['UserName']) { $pp['UserName'] = "$env:UserName" }
+# Requires Choocolatey v0.10.8+ for Read-Host -AsSecureString
+if (!$pp['Password']) { $pp['Password'] = Read-Host "Enter password for $($pp['UserName']):" -AsSecureString}
 # fail the install/upgrade if not value is not determined
 if (!$pp['Password']) { throw "Package needs Password to install, that must be provided in params or in prompt." }
 ~~~
@@ -113,6 +115,12 @@ compatibility with `chocolatey-core.extension`, use `:`.
 
 For example `-Parameters "/ITEM1:value /ITEM2:value with spaces"
 
+NOTE: In 0.10.9+, to maintain compatibility with the prior art of the
+chocolatey-core.extension method, quotes and apostrophes surrounding
+parameter values will be removed. When the param is used, those items
+can be added back if desired, but it's most important to ensure that
+existing packages are compatible on upgrade.
+
 Property               | Value
 ---------------------- | ------
 Aliases                | params