From 22834ab2bada70faac030fa909de4fafffae8426 Mon Sep 17 00:00:00 2001 From: "Thomas A. Christensen II" <25492070+MillironX@users.noreply.github.com> Date: Mon, 7 Oct 2019 10:21:56 -0700 Subject: [PATCH] Add an empty (blank) package to copy stuff from --- blank/ReadMe.md | 133 ++++++++++++++++++++++ blank/_TODO.txt | 131 +++++++++++++++++++++ blank/blank.nuspec | 80 +++++++++++++ blank/tools/LICENSE.txt | 11 ++ blank/tools/VERIFICATION.txt | 13 +++ blank/tools/chocolateybeforemodify.ps1 | 9 ++ blank/tools/chocolateyinstall.ps1 | 151 +++++++++++++++++++++++++ blank/tools/chocolateyuninstall.ps1 | 84 ++++++++++++++ 8 files changed, 612 insertions(+) create mode 100644 blank/ReadMe.md create mode 100644 blank/_TODO.txt create mode 100644 blank/blank.nuspec create mode 100644 blank/tools/LICENSE.txt create mode 100644 blank/tools/VERIFICATION.txt create mode 100644 blank/tools/chocolateybeforemodify.ps1 create mode 100644 blank/tools/chocolateyinstall.ps1 create mode 100644 blank/tools/chocolateyuninstall.ps1 diff --git a/blank/ReadMe.md b/blank/ReadMe.md new file mode 100644 index 0000000..5046086 --- /dev/null +++ b/blank/ReadMe.md @@ -0,0 +1,133 @@ +## Summary +How do I create packages? See https://chocolatey.org/docs/create-packages + +If you are submitting packages to the community feed (https://chocolatey.org) +always try to ensure you have read, understood and adhere to the create +packages wiki link above. + +## Automatic Packaging Updates? +Consider making this package an automatic package, for the best +maintainability over time. Read up at https://chocolatey.org/docs/automatic-packages + +## Shim Generation +Any executables you include in the package or download (but don't call +install against using the built-in functions) will be automatically shimmed. + +This means those executables will automatically be included on the path. +Shim generation runs whether the package is self-contained or uses automation +scripts. + +By default, these are considered console applications. + +If the application is a GUI, you should create an empty file next to the exe +named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'. +See https://chocolatey.org/docs/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui + +If you want to ignore the executable, create an empty file next to the exe +named 'name.exe.ignore' e.g. 'bob.exe' would need a file named +'bob.exe.ignore'. +See https://chocolatey.org/docs/create-packages#how-do-i-exclude-executables-from-getting-shims + +## Self-Contained? +If you have a self-contained package, you can remove the automation scripts +entirely and just include the executables, they will automatically get shimmed, +which puts them on the path. Ensure you have the legal right to distribute +the application though. See https://chocolatey.org/docs/legal. + +You should read up on the Shim Generation section to familiarize yourself +on what to do with GUI applications and/or ignoring shims. + +## Automation Scripts +You have a powerful use of Chocolatey, as you are using PowerShell. So you +can do just about anything you need. Choco has some very handy built-in +functions that you can use, these are sometimes called the helpers. + +### Built-In Functions +https://chocolatey.org/docs/helpers-reference + +A note about a couple: +* Get-BinRoot - this is a horribly named function that doesn't do what new folks think it does. It gets you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://chocolatey.org/docs/helpers-get-tools-location +* Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://chocolatey.org/docs/helpers-install-bin-file +* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://chocolatey.org/docs/helpers-uninstall-bin-file + +### Getting package specific information +Use the package parameters pattern - see https://chocolatey.org/docs/how-to-parse-package-parameters-argument + +### Need to mount an ISO? +https://chocolatey.org/docs/how-to-mount-an-iso-in-chocolatey-package + +### Environment Variables +Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow): + + * TEMP/TMP - Overridden to the CacheLocation, but may be the same as the original TEMP folder + * ChocolateyInstall - Top level folder where Chocolatey is installed + * ChocolateyPackageName - The name of the package, equivalent to the `` field in the nuspec (0.9.9+) + * ChocolateyPackageTitle - The title of the package, equivalent to the `` field in the nuspec (0.10.1+) + * ChocolateyPackageVersion - The version of the package, equivalent to the `<version />` field in the nuspec (0.9.9+) + * ChocolateyPackageFolder - The top level location of the package folder - the folder where Chocolatey has downloaded and extracted the NuGet package, typically `C:\ProgramData\chocolatey\lib\packageName`. + +#### Advanced Environment Variables +The following are more advanced settings: + + * ChocolateyPackageParameters - Parameters to use with packaging, not the same as install arguments (which are passed directly to the native installer). Based on `--package-parameters`. (0.9.8.22+) + * CHOCOLATEY_VERSION - The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. (0.9.9+) - Otherwise take a dependency on the specific version you need. + * ChocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. (0.9.9+) - Automatically handled in built in Choco functions. + * OS_PLATFORM - Like Windows, OSX, Linux. (0.9.9+) + * OS_VERSION - The version of OS, like 6.1 something something for Windows. (0.9.9+) + * OS_NAME - The reported name of the OS. (0.9.9+) + * USER_NAME = The user name (0.10.6+) + * USER_DOMAIN = The user domain name (could also be local computer name) (0.10.6+) + * IS_PROCESSELEVATED = Is the process elevated? (0.9.9+) + * IS_SYSTEM = Is the user the system account? (0.10.6+) + * IS_REMOTEDESKTOP = Is the user in a terminal services session? (0.10.6+) + * ChocolateyToolsLocation - formerly 'ChocolateyBinRoot' ('ChocolateyBinRoot' will be removed with Chocolatey v2.0.0), this is where tools being installed outside of Chocolatey packaging will go. (0.9.10+) + +#### Set By Options and Configuration +Some environment variables are set based on options that are passed, configuration and/or features that are turned on: + + * ChocolateyEnvironmentDebug - Was `--debug` passed? If using the built-in PowerShell host, this is always true (but only logs debug messages to console if `--debug` was passed) (0.9.10+) + * ChocolateyEnvironmentVerbose - Was `--verbose` passed? If using the built-in PowerShell host, this is always true (but only logs verbose messages to console if `--verbose` was passed). (0.9.10+) + * ChocolateyForce - Was `--force` passed? (0.9.10+) + * ChocolateyForceX86 - Was `-x86` passed? (CHECK) + * ChocolateyRequestTimeout - How long before a web request will time out. Set by config `webRequestTimeoutSeconds` (CHECK) + * ChocolateyResponseTimeout - How long to wait for a download to complete? Set by config `commandExecutionTimeoutSeconds` (CHECK) + * ChocolateyPowerShellHost - Are we using the built-in PowerShell host? Set by `--use-system-powershell` or the feature `powershellHost` (0.9.10+) + +#### Business Edition Variables + + * ChocolateyInstallArgumentsSensitive - Encrypted arguments passed from command line `--install-arguments-sensitive` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+) + * ChocolateyPackageParametersSensitive - Package parameters passed from command line `--package-parameters-senstivite` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+) + * ChocolateyLicensedVersion - What version is the licensed edition on? + * ChocolateyLicenseType - What edition / type of the licensed edition is installed? + * USER_CONTEXT - The original user context - different when self-service is used (Licensed v1.10.0+) + +#### Experimental Environment Variables +The following are experimental or use not recommended: + + * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under (0.9.9+) + * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different (0.9.9+) - based on git describe + * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+) + * IS_REMOTE = Is the user in a remote session? (0.10.6+) + +#### Not Useful Or Anti-Pattern If Used + + * ChocolateyInstallOverride = Not for use in package automation scripts. Based on `--override-arguments` being passed. (0.9.9+) + * ChocolateyInstallArguments = The installer arguments meant for the native installer. You should use chocolateyPackageParameters instead. Based on `--install-arguments` being passed. (0.9.9+) + * ChocolateyIgnoreChecksums - Was `--ignore-checksums` passed or the feature `checksumFiles` turned off? (0.9.9.9+) + * ChocolateyAllowEmptyChecksums - Was `--allow-empty-checksums` passed or the feature `allowEmptyChecksums` turned on? (0.10.0+) + * ChocolateyAllowEmptyChecksumsSecure - Was `--allow-empty-checksums-secure` passed or the feature `allowEmptyChecksumsSecure` turned on? (0.10.0+) + * ChocolateyCheckLastExitCode - Should Chocolatey check LASTEXITCODE? Is the feature `scriptsCheckLastExitCode` turned on? (0.10.3+) + * ChocolateyChecksum32 - Was `--download-checksum` passed? (0.10.0+) + * ChocolateyChecksumType32 - Was `--download-checksum-type` passed? (0.10.0+) + * ChocolateyChecksum64 - Was `--download-checksum-x64` passed? (0.10.0)+ + * ChocolateyChecksumType64 - Was `--download-checksum-type-x64` passed? (0.10.0)+ + * ChocolateyPackageExitCode - The exit code of the script that just ran - usually set by `Set-PowerShellExitCode` (CHECK) + * ChocolateyLastPathUpdate - Set by Chocolatey as part of install, but not used for anything in particular in packaging. + * ChocolateyProxyLocation - The explicit proxy location as set in the configuration `proxy` (0.9.9.9+) + * ChocolateyDownloadCache - Use available download cache? Set by `--skip-download-cache`, `--use-download-cache`, or feature `downloadCache` (0.9.10+ and licensed editions 1.1.0+) + * ChocolateyProxyBypassList - Explicitly set locations to ignore in configuration `proxyBypassList` (0.10.4+) + * ChocolateyProxyBypassOnLocal - Should the proxy bypass on local connections? Set based on configuration `proxyBypassOnLocal` (0.10.4+) + * http_proxy - Set by original `http_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+) + * https_proxy - Set by original `https_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+) + * no_proxy- Set by original `no_proxy` passthrough, or same as `ChocolateyProxyBypassList` if explicitly set. (0.10.4+) + diff --git a/blank/_TODO.txt b/blank/_TODO.txt new file mode 100644 index 0000000..e87e0c8 --- /dev/null +++ b/blank/_TODO.txt @@ -0,0 +1,131 @@ +TODO + +1. Determine Package Use: + + Organization? Internal Use? - You are not subject to distribution + rights when you keep everything internal. Put the binaries directly + into the tools directory (as long as total nupkg size is under 1GB). + When bigger, look to use from a share or download binaries from an + internal location. Embedded binaries makes for the most reliable use + of Chocolatey. Use `$fileLocation` (`$file`/`$file64`) and + `Install-ChocolateyInstallPackage`/`Get-ChocolateyUnzip` in + tools\chocolateyInstall.ps1. + + You can also choose to download from internal urls, see the next + section, but ignore whether you have distribution rights or not, it + doesn't apply. Under no circumstances should download from the + internet, it is completely unreliable. See + https://chocolatey.org/docs/community-packages-disclaimer#organizations + to understand the limitations of a publicly available repository. + + Community Repository? + Have Distribution Rights? + If you are the software vendor OR the software EXPLICITLY allows + redistribution and the total nupkg size will be under 200MB, you + have the option to embed the binaries directly into the package to + provide the most reliable install experience. Put the binaries + directly into the tools folder, use `$fileLocation` (`$file`/ + `$file64`) and `Install-ChocolateyInstallPackage`/ + `Get-ChocolateyUnzip` in tools\chocolateyInstall.ps1. Additionally, + fill out the LICENSE and VERIFICATION file (see 3 below and those + files for specifics). + + NOTE: You can choose to download binaries at runtime, but be sure + the download location will remain stable. See the next section. + + Do Not Have Distribution Rights? + - Note: Packages built this way cannot be 100% reliable, but it's a + constraint of publicly available packages and there is little + that can be done to change that. See + https://chocolatey.org/docs/community-packages-disclaimer#organizations + to better understand the limitations of a publicly available + repository. + Download Location is Publicly Available? + You will need to download the runtime files from their official + location at runtime. Use `$url`/`$url64` and + `Install-ChocolateyPackage`/`Install-ChocolateyZipPackage` in + tools\chocolateyInstall.ps1. + Download Location is Not Publicly Available? + Stop here, you can't push this to the community repository. You + can ask the vendor for permission to embed, then include a PDF of + that signed permission directly in the package. Otherwise you + will need to seek alternate locations to non-publicly host the + package. + Download Location Is Same For All Versions? + You still need to point to those urls, but you may wish to set up + something like Automatic Updater (AU) so that when a new version + of the software becomes available, the new package version + automatically gets pushed up to the community repository. See + https://chocolatey.org/docs/automatic-packages#automatic-updater-au + +2. Determine Package Type: + +- Installer Package - contains an installer (everything in template is + geared towards this type of package) +- Zip Package - downloads or embeds and unpacks archives, may unpack + and run an installer using `Install-ChocolateyInstallPackage` as a + secondary step. +- Portable Package - Contains runtime binaries (or unpacks them as a + zip package) - cannot require administrative permissions to install + or use +- Config Package - sets config like files, registry keys, etc +- Extension Package - Packages that add PowerShell functions to + Chocolatey - https://chocolatey.org/docs/how-to-create-extensions +- Template Package - Packages that add templates like this for `choco + new -t=name` - https://chocolatey.org/docs/how-to-create-custom-package-templates +- Other - there are other types of packages as well, these are the main + package types seen in the wild + +3. Fill out the package contents: + +- tools\chocolateyBeforeModify.ps1 - remove if you have no processes + or services to shut down before upgrade/uninstall +- tools\LICENSE.txt / tools\VERIFICATION.txt - Remove if you are not + embedding binaries. Keep and fill out if you are embedding binaries + in the package AND pushing to the community repository, even if you + are the author of software. The file becomes easier to fill out + (does not require changes each version) if you are the software + vendor. If you are building packages for internal use (organization, + etc), you don't need these files as you are not subject to + distribution rights internally. +- tools\chocolateyUninstall.ps1 - remove if autouninstaller can + automatically uninstall and you have nothing additional to do during + uninstall +- Readme.txt - delete this file once you have read over and used + anything you've needed from here +- nuspec - fill this out, then clean out all the comments (you may wish + to leave the headers for the package vs software metadata) +- tools\chocolateyInstall.ps1 - instructions in next section. + +4. ChocolateyInstall.ps1: + +- For embedded binaries - use `$fileLocation` (`$file`/`$file64`) and + `Install-ChocolateyInstallPackage`/ `Get-ChocolateyUnzip`. +- Downloading binaries at runtime - use `$url`/`$url64` and + `Install-ChocolateyPackage` / `Install-ChocolateyZipPackage`. +- Other needs (creating files, setting registry keys), use regular + PowerShell to do so or see if there is a function already defined: + https://chocolatey.org/docs/helpers-reference +- There may also be functions available in extension packages, see + https://chocolatey.org/packages?q=id%3A.extension for examples and + availability. +- Clean out the comments and sections you are not using. + +5. Test the package to ensure install/uninstall work appropriately. + There is a test environment you can use for this - + https://github.com/chocolatey/chocolatey-test-environment + +6. Learn more about Chocolatey packaging - go through the workshop at + https://github.com/ferventcoder/chocolatey-workshop + You will learn about + - General packaging + - Customizing package behavior at runtime (package parameters) + - Extension packages + - Custom packaging templates + - Setting up an internal Chocolatey.Server repository + - Adding and using internal repositories + - Reporting + - Advanced packaging techniques when installers are not friendly to + automation + +7. Delete this file. diff --git a/blank/blank.nuspec b/blank/blank.nuspec new file mode 100644 index 0000000..bbc4616 --- /dev/null +++ b/blank/blank.nuspec @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Read this before creating packages: https://chocolatey.org/docs/create-packages --> +<!-- It is especially important to read the above link to understand additional requirements when publishing packages to the community feed aka dot org (https://chocolatey.org/packages). --> + +<!-- Test your packages in a test environment: https://github.com/chocolatey/chocolatey-test-environment --> + +<!-- +This is a nuspec. It mostly adheres to https://docs.nuget.org/create/Nuspec-Reference. Chocolatey uses a special version of NuGet.Core that allows us to do more than was initially possible. As such there are certain things to be aware of: + +* the package xmlns schema url may cause issues with nuget.exe +* Any of the following elements can ONLY be used by choco tools - projectSourceUrl, docsUrl, mailingListUrl, bugTrackerUrl, packageSourceUrl, provides, conflicts, replaces +* nuget.exe can still install packages with those elements but they are ignored. Any authoring tools or commands will error on those elements +--> + +<!-- You can embed software files directly into packages, as long as you are not bound by distribution rights. --> +<!-- * If you are an organization making private packages, you probably have no issues here --> +<!-- * If you are releasing to the community feed, you need to consider distribution rights. --> +<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. --> +<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd"> + <metadata> + <!-- == PACKAGE SPECIFIC SECTION == --> + <!-- This section is about this package, although id and version have ties back to the software --> + <!-- id is lowercase and if you want a good separator for words, use '-', not '.'. Dots are only acceptable as suffixes for certain types of packages, e.g. .install, .portable, .extension, .template --> + <!-- If the software is cross-platform, attempt to use the same id as the debian/rpm package(s) if possible. --> + <id>blank</id> + <!-- version should MATCH as closely as possible with the underlying software --> + <!-- Is the version a prerelease of a version? https://docs.nuget.org/create/versioning#creating-prerelease-packages --> + <!-- Note that unstable versions like 0.0.1 can be considered a released version, but it's possible that one can release a 0.0.1-beta before you release a 0.0.1 version. If the version number is final, that is considered a released version and not a prerelease. --> + <version>__REPLACE__</version> + <!-- <packageSourceUrl>Where is this Chocolatey package located (think GitHub)? packageSourceUrl is highly recommended for the community feed</packageSourceUrl>--> + <!-- owners is a poor name for maintainers of the package. It sticks around by this name for compatibility reasons. It basically means you. --> + <!--<owners>__REPLACE_YOUR_NAME__</owners>--> + <!-- ============================== --> + + <!-- == SOFTWARE SPECIFIC SECTION == --> + <!-- This section is about the software itself --> + <title>blank (Install) + __REPLACE_AUTHORS_OF_SOFTWARE_COMMA_SEPARATED__ + + https://_Software_Location_REMOVE_OR_FILL_OUT_ + + + + + + + + + blank SPACE_SEPARATED + __REPLACE__ + __REPLACE__MarkDown_Okay + + + + + + + + + + + + + + + + + diff --git a/blank/tools/LICENSE.txt b/blank/tools/LICENSE.txt new file mode 100644 index 0000000..e04744b --- /dev/null +++ b/blank/tools/LICENSE.txt @@ -0,0 +1,11 @@ + +Note: Include this file if including binaries you have the right to distribute. +Otherwise delete. this file. + +===DELETE ABOVE THIS LINE AND THIS LINE=== + +From: + +LICENSE + + diff --git a/blank/tools/VERIFICATION.txt b/blank/tools/VERIFICATION.txt new file mode 100644 index 0000000..33deb5a --- /dev/null +++ b/blank/tools/VERIFICATION.txt @@ -0,0 +1,13 @@ + +Note: Include this file if including binaries you have the right to distribute. +Otherwise delete. this file. If you are the software author, you can change this +mention you are the author of the software. + +===DELETE ABOVE THIS LINE AND THIS LINE=== + +VERIFICATION +Verification is intended to assist the Chocolatey moderators and community +in verifying that this package's contents are trustworthy. + + + \ No newline at end of file diff --git a/blank/tools/chocolateybeforemodify.ps1 b/blank/tools/chocolateybeforemodify.ps1 new file mode 100644 index 0000000..9588ffe --- /dev/null +++ b/blank/tools/chocolateybeforemodify.ps1 @@ -0,0 +1,9 @@ +# This runs in 0.9.10+ before upgrade and uninstall. +# Use this file to do things like stop services prior to upgrade or uninstall. +# NOTE: It is an anti-pattern to call chocolateyUninstall.ps1 from here. If you +# need to uninstall an MSI prior to upgrade, put the functionality in this +# file without calling the uninstall script. Make it idempotent in the +# uninstall script so that it doesn't fail when it is already uninstalled. +# NOTE: For upgrades - like the uninstall script, this script always runs from +# the currently installed version, not from the new upgraded package version. + diff --git a/blank/tools/chocolateyinstall.ps1 b/blank/tools/chocolateyinstall.ps1 new file mode 100644 index 0000000..59c07e9 --- /dev/null +++ b/blank/tools/chocolateyinstall.ps1 @@ -0,0 +1,151 @@ +# IMPORTANT: Before releasing this package, copy/paste the next 2 lines into PowerShell to remove all comments from this file: +# $f='c:\path\to\thisFile.ps1' +# gc $f | ? {$_ -notmatch "^\s*#"} | % {$_ -replace '(^.*?)\s*?[^``]#.*','$1'} | Out-File $f+".~" -en utf8; mv -fo $f+".~" $f + +# 1. See the _TODO.md that is generated top level and read through that +# 2. Follow the documentation below to learn how to create a package for the package type you are creating. +# 3. In Chocolatey scripts, ALWAYS use absolute paths - $toolsDir gets you to the package's tools directory. +$ErrorActionPreference = 'Stop'; # stop on all errors +$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" +# Internal packages (organizations) or software that has redistribution rights (community repo) +# - Use `Install-ChocolateyInstallPackage` instead of `Install-ChocolateyPackage` +# and put the binaries directly into the tools folder (we call it embedding) +#$fileLocation = Join-Path $toolsDir 'NAME_OF_EMBEDDED_INSTALLER_FILE' +# If embedding binaries increase total nupkg size to over 1GB, use share location or download from urls +#$fileLocation = '\\SHARE_LOCATION\to\INSTALLER_FILE' +# Community Repo: Use official urls for non-redist binaries or redist where total package size is over 200MB +# Internal/Organization: Download from internal location (internet sources are unreliable) +$url = '' # download url, HTTPS preferred +$url64 = '' # 64bit URL here (HTTPS preferred) or remove - if installer contains both (very rare), use $url + +$packageArgs = @{ + packageName = $env:ChocolateyPackageName + unzipLocation = $toolsDir + fileType = 'EXE_MSI_OR_MSU' #only one of these: exe, msi, msu + url = $url + url64bit = $url64 + #file = $fileLocation + + softwareName = 'blank*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique + + # Checksums are now required as of 0.10.0. + # To determine checksums, you can get that from the original site if provided. + # You can also use checksum.exe (choco install checksum) and use it + # e.g. checksum -t sha256 -f path\to\file + checksum = '' + checksumType = 'sha256' #default is md5, can also be sha1, sha256 or sha512 + checksum64 = '' + checksumType64= 'sha256' #default is checksumType + + # MSI + silentArgs = "/qn /norestart /l*v `"$($env:TEMP)\$($packageName).$($env:chocolateyPackageVersion).MsiInstall.log`"" # ALLUSERS=1 DISABLEDESKTOPSHORTCUT=1 ADDDESKTOPICON=0 ADDSTARTMENU=0 + validExitCodes= @(0, 3010, 1641) + # OTHERS + # Uncomment matching EXE type (sorted by most to least common) + #silentArgs = '/S' # NSIS + #silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup + #silentArgs = '/s' # InstallShield + #silentArgs = '/s /v"/qn"' # InstallShield with MSI + #silentArgs = '/s' # Wise InstallMaster + #silentArgs = '-s' # Squirrel + #silentArgs = '-q' # Install4j + #silentArgs = '-s' # Ghost + # Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence. + #silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK) + # https://chocolatey.org/packages/autohotkey.portable + #validExitCodes= @(0) #please insert other valid exit codes here +} + +Install-ChocolateyPackage @packageArgs # https://chocolatey.org/docs/helpers-install-chocolatey-package +#Install-ChocolateyZipPackage @packageArgs # https://chocolatey.org/docs/helpers-install-chocolatey-zip-package +## If you are making your own internal packages (organizations), you can embed the installer or +## put on internal file share and use the following instead (you'll need to add $file to the above) +#Install-ChocolateyInstallPackage @packageArgs # https://chocolatey.org/docs/helpers-install-chocolatey-install-package + +## Main helper functions - these have error handling tucked into them already +## see https://chocolatey.org/docs/helpers-reference + +## Install an application, will assert administrative rights +## - https://chocolatey.org/docs/helpers-install-chocolatey-package +## - https://chocolatey.org/docs/helpers-install-chocolatey-install-package +## add additional optional arguments as necessary +##Install-ChocolateyPackage $packageName $fileType $silentArgs $url [$url64 -validExitCodes $validExitCodes -checksum $checksum -checksumType $checksumType -checksum64 $checksum64 -checksumType64 $checksumType64] + +## Download and unpack a zip file - https://chocolatey.org/docs/helpers-install-chocolatey-zip-package +##Install-ChocolateyZipPackage $packageName $url $toolsDir [$url64 -checksum $checksum -checksumType $checksumType -checksum64 $checksum64 -checksumType64 $checksumType64] + +## Install Visual Studio Package - https://chocolatey.org/docs/helpers-install-chocolatey-vsix-package +#Install-ChocolateyVsixPackage $packageName $url [$vsVersion] [-checksum $checksum -checksumType $checksumType] +#Install-ChocolateyVsixPackage @packageArgs + +## see the full list at https://chocolatey.org/docs/helpers-reference + +## downloader that the main helpers use to download items +## if removing $url64, please remove from here +## - https://chocolatey.org/docs/helpers-get-chocolatey-web-file +#Get-ChocolateyWebFile $packageName 'DOWNLOAD_TO_FILE_FULL_PATH' $url $url64 + +## Installer, will assert administrative rights - used by Install-ChocolateyPackage +## use this for embedding installers in the package when not going to community feed or when you have distribution rights +## - https://chocolatey.org/docs/helpers-install-chocolatey-install-package +#Install-ChocolateyInstallPackage $packageName $fileType $silentArgs '_FULLFILEPATH_' -validExitCodes $validExitCodes + +## Unzips a file to the specified location - auto overwrites existing content +## - https://chocolatey.org/docs/helpers-get-chocolatey-unzip +#Get-ChocolateyUnzip "FULL_LOCATION_TO_ZIP.zip" $toolsDir + +## Runs processes asserting UAC, will assert administrative rights - used by Install-ChocolateyInstallPackage +## - https://chocolatey.org/docs/helpers-start-chocolatey-process-as-admin +#Start-ChocolateyProcessAsAdmin 'STATEMENTS_TO_RUN' 'Optional_Application_If_Not_PowerShell' -validExitCodes $validExitCodes + +## To avoid quoting issues, you can also assemble your -Statements in another variable and pass it in +#$appPath = "$env:ProgramFiles\appname" +##Will resolve to C:\Program Files\appname +#$statementsToRun = "/C `"$appPath\bin\installservice.bat`"" +#Start-ChocolateyProcessAsAdmin $statementsToRun cmd -validExitCodes $validExitCodes + +## add specific folders to the path - any executables found in the chocolatey package +## folder will already be on the path. This is used in addition to that or for cases +## when a native installer doesn't add things to the path. +## - https://chocolatey.org/docs/helpers-install-chocolatey-path +#Install-ChocolateyPath 'LOCATION_TO_ADD_TO_PATH' 'User_OR_Machine' # Machine will assert administrative rights + +## Add specific files as shortcuts to the desktop +## - https://chocolatey.org/docs/helpers-install-chocolatey-shortcut +#$target = Join-Path $toolsDir "$($packageName).exe" +# Install-ChocolateyShortcut -shortcutFilePath "" -targetPath "" [-workDirectory "C:\" -arguments "C:\test.txt" -iconLocation "C:\test.ico" -description "This is the description"] + +## Outputs the bitness of the OS (either "32" or "64") +## - https://chocolatey.org/docs/helpers-get-o-s-architecture-width +#$osBitness = Get-ProcessorBits + +## Set persistent Environment variables +## - https://chocolatey.org/docs/helpers-install-chocolatey-environment-variable +#Install-ChocolateyEnvironmentVariable -variableName "SOMEVAR" -variableValue "value" [-variableType = 'Machine' #Defaults to 'User'] + +## Set up a file association +## - https://chocolatey.org/docs/helpers-install-chocolatey-file-association +#Install-ChocolateyFileAssociation + +## Adding a shim when not automatically found - Cocolatey automatically shims exe files found in package directory. +## - https://chocolatey.org/docs/helpers-install-bin-file +## - https://chocolatey.org/docs/create-packages#how-do-i-exclude-executables-from-getting-shims +#Install-BinFile + +##PORTABLE EXAMPLE +#$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" +# despite the name "Install-ChocolateyZipPackage" this also works with 7z archives +#Install-ChocolateyZipPackage $packageName $url $toolsDir $url64 +## END PORTABLE EXAMPLE + +## [DEPRECATING] PORTABLE EXAMPLE +#$binRoot = Get-BinRoot +#$installDir = Join-Path $binRoot "$packageName" +#Write-Host "Adding `'$installDir`' to the path and the current shell path" +#Install-ChocolateyPath "$installDir" +#$env:Path = "$($env:Path);$installDir" + +# if removing $url64, please remove from here +# despite the name "Install-ChocolateyZipPackage" this also works with 7z archives +#Install-ChocolateyZipPackage "$packageName" "$url" "$installDir" "$url64" +## END PORTABLE EXAMPLE diff --git a/blank/tools/chocolateyuninstall.ps1 b/blank/tools/chocolateyuninstall.ps1 new file mode 100644 index 0000000..765b879 --- /dev/null +++ b/blank/tools/chocolateyuninstall.ps1 @@ -0,0 +1,84 @@ +# IMPORTANT: Before releasing this package, copy/paste the next 2 lines into PowerShell to remove all comments from this file: +# $f='c:\path\to\thisFile.ps1' +# gc $f | ? {$_ -notmatch "^\s*#"} | % {$_ -replace '(^.*?)\s*?[^``]#.*','$1'} | Out-File $f+".~" -en utf8; mv -fo $f+".~" $f + +## NOTE: In 80-90% of the cases (95% with licensed versions due to Package Synchronizer and other enhancements), +## AutoUninstaller should be able to detect and handle registry uninstalls without a chocolateyUninstall.ps1. +## See https://chocolatey.org/docs/commands-uninstall +## and https://chocolatey.org/docs/helpers-uninstall-chocolatey-package + +## If this is an MSI, ensure 'softwareName' is appropriate, then clean up comments and you are done. +## If this is an exe, change fileType, silentArgs, and validExitCodes + +$ErrorActionPreference = 'Stop'; # stop on all errors +$packageArgs = @{ + packageName = $env:ChocolateyPackageName + softwareName = 'blank*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique + fileType = 'EXE_MSI_OR_MSU' #only one of these: MSI or EXE (ignore MSU for now) + # MSI + silentArgs = "/qn /norestart" + validExitCodes= @(0, 3010, 1605, 1614, 1641) # https://msdn.microsoft.com/en-us/library/aa376931(v=vs.85).aspx + # OTHERS + # Uncomment matching EXE type (sorted by most to least common) + #silentArgs = '/S' # NSIS + #silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup + #silentArgs = '/s' # InstallShield + #silentArgs = '/s /v"/qn"' # InstallShield with MSI + #silentArgs = '/s' # Wise InstallMaster + #silentArgs = '-s' # Squirrel + #silentArgs = '-q' # Install4j + #silentArgs = '-s -u' # Ghost + # Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence. + #silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK) + # https://chocolatey.org/packages/autohotkey.portable + #validExitCodes= @(0) #please insert other valid exit codes here +} + +$uninstalled = $false +# Get-UninstallRegistryKey is new to 0.9.10, if supporting 0.9.9.x and below, +# take a dependency on "chocolatey-core.extension" in your nuspec file. +# This is only a fuzzy search if $softwareName includes '*'. Otherwise it is +# exact. In the case of versions in key names, we recommend removing the version +# and using '*'. +[array]$key = Get-UninstallRegistryKey -SoftwareName $packageArgs['softwareName'] + +if ($key.Count -eq 1) { + $key | % { + $packageArgs['file'] = "$($_.UninstallString)" #NOTE: You may need to split this if it contains spaces, see below + + if ($packageArgs['fileType'] -eq 'MSI') { + # The Product Code GUID is all that should be passed for MSI, and very + # FIRST, because it comes directly after /x, which is already set in the + # Uninstall-ChocolateyPackage msiargs (facepalm). + $packageArgs['silentArgs'] = "$($_.PSChildName) $($packageArgs['silentArgs'])" + + # Don't pass anything for file, it is ignored for msi (facepalm number 2) + # Alternatively if you need to pass a path to an msi, determine that and + # use it instead of the above in silentArgs, still very first + $packageArgs['file'] = '' + } else { + # NOTES: + # - You probably will need to sanitize $packageArgs['file'] as it comes from the registry and could be in a variety of fun but unusable formats + # - Split args from exe in $packageArgs['file'] and pass those args through $packageArgs['silentArgs'] or ignore them + # - Ensure you don't pass double quotes in $file (aka $packageArgs['file']) - otherwise you will get "Illegal characters in path when you attempt to run this" + # - Review the code for auto-uninstaller for all of the fun things it does in sanitizing - https://github.com/chocolatey/choco/blob/bfe351b7d10c798014efe4bfbb100b171db25099/src/chocolatey/infrastructure.app/services/AutomaticUninstallerService.cs#L142-L192 + } + + Uninstall-ChocolateyPackage @packageArgs + } +} elseif ($key.Count -eq 0) { + Write-Warning "$packageName has already been uninstalled by other means." +} elseif ($key.Count -gt 1) { + Write-Warning "$($key.Count) matches found!" + Write-Warning "To prevent accidental data loss, no programs will be uninstalled." + Write-Warning "Please alert package maintainer the following keys were matched:" + $key | % {Write-Warning "- $($_.DisplayName)"} +} + +## OTHER POWERSHELL FUNCTIONS +## https://chocolatey.org/docs/helpers-reference +#Uninstall-ChocolateyZipPackage $packageName # Only necessary if you did not unpack to package directory - see https://chocolatey.org/docs/helpers-uninstall-chocolatey-zip-package +#Uninstall-ChocolateyEnvironmentVariable # 0.9.10+ - https://chocolatey.org/docs/helpers-uninstall-chocolatey-environment-variable +#Uninstall-BinFile # Only needed if you used Install-BinFile - see https://chocolatey.org/docs/helpers-uninstall-bin-file +## Remove any shortcuts you added in the install script. +