Remove unused files from repository as they are not needed
This commit is contained in:
Steven Pickles
parent
a0070c87d9
commit
ecac52c31a
131
_TODO.txt
131
_TODO.txt
@ -1,131 +0,0 @@
|
|||||||
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.
|
|
||||||
@ -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.
|
|
||||||
|
|
||||||
@ -1,84 +0,0 @@
|
|||||||
# 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 = 'CricutDesignSpace*' #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.
|
|
||||||
|
|
||||||
Loading…
x
Reference in New Issue
Block a user