diff --git a/manual/zip.template/templates/ReadMe.md b/manual/zip.template/templates/ReadMe.md deleted file mode 100644 index 7b96a3af7..000000000 --- a/manual/zip.template/templates/ReadMe.md +++ /dev/null @@ -1,91 +0,0 @@ -## 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 = 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 id in the nuspec (0.9.9+) - * chocolateyPackageVersion = The version of the package, equivalent to the version in the nuspec (0.9.9+) - * chocolateyPackageFolder = The top level location of the package folder - -#### Advanced Environment Variables -The following are more advanced settings: - - * chocolateyPackageParameters = (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+) - * IS_PROCESSELEVATED = Is the process elevated? (0.9.9+) - -#### 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+) - - it's based on git describe - * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+) - * chocolateyInstallOverride = Not for use in package automation scripts. (0.9.9+) - * chocolateyInstallArguments = the installer arguments meant for the native installer. You should use chocolateyPackageParameters intead. (0.9.9+) - diff --git a/manual/zip.template/templates/tools/LICENSE.txt b/manual/zip.template/templates/tools/LICENSE.txt deleted file mode 100644 index e04744b63..000000000 --- a/manual/zip.template/templates/tools/LICENSE.txt +++ /dev/null @@ -1,11 +0,0 @@ - -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/manual/zip.template/templates/tools/VERIFICATION.txt b/manual/zip.template/templates/tools/VERIFICATION.txt deleted file mode 100644 index 1a34ca0cf..000000000 --- a/manual/zip.template/templates/tools/VERIFICATION.txt +++ /dev/null @@ -1,11 +0,0 @@ - -Note: Include this file if including binaries you have the right to distribute. -Otherwise delete. this file. - -===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/manual/zip.template/templates/tools/chocolateybeforemodify.ps1 b/manual/zip.template/templates/tools/chocolateybeforemodify.ps1 deleted file mode 100644 index 9588ffe80..000000000 --- a/manual/zip.template/templates/tools/chocolateybeforemodify.ps1 +++ /dev/null @@ -1,9 +0,0 @@ -# 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/manual/zip.template/templates/tools/chocolateyinstall.ps1 b/manual/zip.template/templates/tools/chocolateyinstall.ps1 deleted file mode 100644 index 7850bb2c2..000000000 --- a/manual/zip.template/templates/tools/chocolateyinstall.ps1 +++ /dev/null @@ -1,28 +0,0 @@ -$ErrorActionPreference = 'Stop'; - -[[AutomaticPackageNotesInstaller]] -$packageName= '[[PackageName]]' -$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" -#$fileLocation = Join-Path $toolsDir 'NAME_OF_EMBEDDED_ZIP_FILE' - -$packageArgs = @{ - packageName = $packageName - unzipLocation = $toolsDir - url = '[[Url]]' # download url, HTTPS preferred - url64bit = '[[Url64]]' # 64bit URL here (HTTPS preferred) or remove - if installer contains both (very rare), use $url - #file = $fileLocation - #fileFullPath = $fileLocation - destination = $toolsDir - - checksum = '[[Checksum]]' - checksumType = 'sha256' #default is md5, can also be sha1, sha256 or sha512 - checksum64 = '[[Checksum64]]' - checksumType64= 'sha256' -} - -# https://chocolatey.org/docs/helpers-install-chocolatey-zip-package -Install-ChocolateyZipPackage @packageArgs - -## Unzips a file to the specified location - auto overwrites existing content -## - https://chocolatey.org/docs/helpers-get-chocolatey-unzip -#Get-ChocolateyUnzip @packageArgs \ No newline at end of file diff --git a/manual/zip.template/templates/zip.nuspec.template b/manual/zip.template/templates/zip.nuspec.template deleted file mode 100644 index b1e44ecab..000000000 --- a/manual/zip.template/templates/zip.nuspec.template +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - [[PackageNameLower]] - - - - [[PackageVersion]] - - http://github.com/[[MaintainerRepo]]/[[PackageNameLower]] - - [[MaintainerName]] - - - - - [[PackageName]] (Install) - __REPLACE_AUTHORS_OF_SOFTWARE_COMMA_SEPARATED__ - - https://_Software_Location_REMOVE_OR_FILL_OUT_ - - - - - - - - - [[PackageNameLower]] portable SPACE_SEPARATED - __REPLACE__ - __REPLACE__MarkDown_Okay [[AutomaticPackageNotesNuspec]] - - - - - - - - - - - - - - - - - diff --git a/manual/zip.template/zip.template.nuspec b/manual/zip.template/zip.template.nuspec deleted file mode 100644 index fc3577b2a..000000000 --- a/manual/zip.template/zip.template.nuspec +++ /dev/null @@ -1,27 +0,0 @@ - - - - zip.template - 1.0.0 - https://github.com/ferventcoder/chocolatey-packages - Rob Reynolds, Chocolatey - Chocolatey Zip Template - Rob Reynolds, The Chocolatey Team - https://github.com/chocolatey/choco - https://github.com/chocolatey/choco/raw/master/docs/logo/chocolateyicon.gif - RealDimensions Software, LLC - 2016-Present - https://raw.githubusercontent.com/chocolatey/choco/master/LICENSE - false - - zip package template - https://github.com/chocolatey/choco - Zip Chocolatey template - ### Chocolatey Zip Template -This adds a template for archive (zipped) packages. - - - - - - -