Skip to content

Commit 68add07

Browse files
committed
Chocolatey package
1 parent 22485af commit 68add07

19 files changed

+569
-0
lines changed

.vs/quick-picture-viewer/v16/.suo

0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
-32 KB
Binary file not shown.
-117 KB
Binary file not shown.
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
## Summary
2+
How do I create packages? See https://chocolatey.org/docs/create-packages
3+
4+
If you are submitting packages to the community feed (https://chocolatey.org)
5+
always try to ensure you have read, understood and adhere to the create
6+
packages wiki link above.
7+
8+
## Automatic Packaging Updates?
9+
Consider making this package an automatic package, for the best
10+
maintainability over time. Read up at https://chocolatey.org/docs/automatic-packages
11+
12+
## Shim Generation
13+
Any executables you include in the package or download (but don't call
14+
install against using the built-in functions) will be automatically shimmed.
15+
16+
This means those executables will automatically be included on the path.
17+
Shim generation runs whether the package is self-contained or uses automation
18+
scripts.
19+
20+
By default, these are considered console applications.
21+
22+
If the application is a GUI, you should create an empty file next to the exe
23+
named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'.
24+
See https://chocolatey.org/docs/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui
25+
26+
If you want to ignore the executable, create an empty file next to the exe
27+
named 'name.exe.ignore' e.g. 'bob.exe' would need a file named
28+
'bob.exe.ignore'.
29+
See https://chocolatey.org/docs/create-packages#how-do-i-exclude-executables-from-getting-shims
30+
31+
## Self-Contained?
32+
If you have a self-contained package, you can remove the automation scripts
33+
entirely and just include the executables, they will automatically get shimmed,
34+
which puts them on the path. Ensure you have the legal right to distribute
35+
the application though. See https://chocolatey.org/docs/legal.
36+
37+
You should read up on the Shim Generation section to familiarize yourself
38+
on what to do with GUI applications and/or ignoring shims.
39+
40+
## Automation Scripts
41+
You have a powerful use of Chocolatey, as you are using PowerShell. So you
42+
can do just about anything you need. Choco has some very handy built-in
43+
functions that you can use, these are sometimes called the helpers.
44+
45+
### Built-In Functions
46+
https://chocolatey.org/docs/helpers-reference
47+
48+
A note about a couple:
49+
* 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
50+
* Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://chocolatey.org/docs/helpers-install-bin-file
51+
* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://chocolatey.org/docs/helpers-uninstall-bin-file
52+
53+
### Getting package specific information
54+
Use the package parameters pattern - see https://chocolatey.org/docs/how-to-parse-package-parameters-argument
55+
56+
### Need to mount an ISO?
57+
https://chocolatey.org/docs/how-to-mount-an-iso-in-chocolatey-package
58+
59+
### Environment Variables
60+
Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow):
61+
62+
* TEMP/TMP - Overridden to the CacheLocation, but may be the same as the original TEMP folder
63+
* ChocolateyInstall - Top level folder where Chocolatey is installed
64+
* ChocolateyPackageName - The name of the package, equivalent to the `<id />` field in the nuspec (0.9.9+)
65+
* ChocolateyPackageTitle - The title of the package, equivalent to the `<title />` field in the nuspec (0.10.1+)
66+
* ChocolateyPackageVersion - The version of the package, equivalent to the `<version />` field in the nuspec (0.9.9+)
67+
* 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`.
68+
69+
#### Advanced Environment Variables
70+
The following are more advanced settings:
71+
72+
* 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+)
73+
* 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.
74+
* ChocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. (0.9.9+) - Automatically handled in built in Choco functions.
75+
* OS_PLATFORM - Like Windows, OSX, Linux. (0.9.9+)
76+
* OS_VERSION - The version of OS, like 6.1 something something for Windows. (0.9.9+)
77+
* OS_NAME - The reported name of the OS. (0.9.9+)
78+
* USER_NAME = The user name (0.10.6+)
79+
* USER_DOMAIN = The user domain name (could also be local computer name) (0.10.6+)
80+
* IS_PROCESSELEVATED = Is the process elevated? (0.9.9+)
81+
* IS_SYSTEM = Is the user the system account? (0.10.6+)
82+
* IS_REMOTEDESKTOP = Is the user in a terminal services session? (0.10.6+)
83+
* 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+)
84+
85+
#### Set By Options and Configuration
86+
Some environment variables are set based on options that are passed, configuration and/or features that are turned on:
87+
88+
* 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+)
89+
* 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+)
90+
* ChocolateyForce - Was `--force` passed? (0.9.10+)
91+
* ChocolateyForceX86 - Was `-x86` passed? (CHECK)
92+
* ChocolateyRequestTimeout - How long before a web request will time out. Set by config `webRequestTimeoutSeconds` (CHECK)
93+
* ChocolateyResponseTimeout - How long to wait for a download to complete? Set by config `commandExecutionTimeoutSeconds` (CHECK)
94+
* ChocolateyPowerShellHost - Are we using the built-in PowerShell host? Set by `--use-system-powershell` or the feature `powershellHost` (0.9.10+)
95+
96+
#### Business Edition Variables
97+
98+
* ChocolateyInstallArgumentsSensitive - Encrypted arguments passed from command line `--install-arguments-sensitive` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+)
99+
* ChocolateyPackageParametersSensitive - Package parameters passed from command line `--package-parameters-senstivite` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+)
100+
* ChocolateyLicensedVersion - What version is the licensed edition on?
101+
* ChocolateyLicenseType - What edition / type of the licensed edition is installed?
102+
* USER_CONTEXT - The original user context - different when self-service is used (Licensed v1.10.0+)
103+
104+
#### Experimental Environment Variables
105+
The following are experimental or use not recommended:
106+
107+
* OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under (0.9.9+)
108+
* CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different (0.9.9+) - based on git describe
109+
* IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+)
110+
* IS_REMOTE = Is the user in a remote session? (0.10.6+)
111+
112+
#### Not Useful Or Anti-Pattern If Used
113+
114+
* ChocolateyInstallOverride = Not for use in package automation scripts. Based on `--override-arguments` being passed. (0.9.9+)
115+
* ChocolateyInstallArguments = The installer arguments meant for the native installer. You should use chocolateyPackageParameters instead. Based on `--install-arguments` being passed. (0.9.9+)
116+
* ChocolateyIgnoreChecksums - Was `--ignore-checksums` passed or the feature `checksumFiles` turned off? (0.9.9.9+)
117+
* ChocolateyAllowEmptyChecksums - Was `--allow-empty-checksums` passed or the feature `allowEmptyChecksums` turned on? (0.10.0+)
118+
* ChocolateyAllowEmptyChecksumsSecure - Was `--allow-empty-checksums-secure` passed or the feature `allowEmptyChecksumsSecure` turned on? (0.10.0+)
119+
* ChocolateyCheckLastExitCode - Should Chocolatey check LASTEXITCODE? Is the feature `scriptsCheckLastExitCode` turned on? (0.10.3+)
120+
* ChocolateyChecksum32 - Was `--download-checksum` passed? (0.10.0+)
121+
* ChocolateyChecksumType32 - Was `--download-checksum-type` passed? (0.10.0+)
122+
* ChocolateyChecksum64 - Was `--download-checksum-x64` passed? (0.10.0)+
123+
* ChocolateyChecksumType64 - Was `--download-checksum-type-x64` passed? (0.10.0)+
124+
* ChocolateyPackageExitCode - The exit code of the script that just ran - usually set by `Set-PowerShellExitCode` (CHECK)
125+
* ChocolateyLastPathUpdate - Set by Chocolatey as part of install, but not used for anything in particular in packaging.
126+
* ChocolateyProxyLocation - The explicit proxy location as set in the configuration `proxy` (0.9.9.9+)
127+
* 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+)
128+
* ChocolateyProxyBypassList - Explicitly set locations to ignore in configuration `proxyBypassList` (0.10.4+)
129+
* ChocolateyProxyBypassOnLocal - Should the proxy bypass on local connections? Set based on configuration `proxyBypassOnLocal` (0.10.4+)
130+
* http_proxy - Set by original `http_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+)
131+
* https_proxy - Set by original `https_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+)
132+
* no_proxy- Set by original `no_proxy` passthrough, or same as `ChocolateyProxyBypassList` if explicitly set. (0.10.4+)
133+
Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
TODO
2+
3+
1. Determine Package Use:
4+
5+
Organization? Internal Use? - You are not subject to distribution
6+
rights when you keep everything internal. Put the binaries directly
7+
into the tools directory (as long as total nupkg size is under 1GB).
8+
When bigger, look to use from a share or download binaries from an
9+
internal location. Embedded binaries makes for the most reliable use
10+
of Chocolatey. Use `$fileLocation` (`$file`/`$file64`) and
11+
`Install-ChocolateyInstallPackage`/`Get-ChocolateyUnzip` in
12+
tools\chocolateyInstall.ps1.
13+
14+
You can also choose to download from internal urls, see the next
15+
section, but ignore whether you have distribution rights or not, it
16+
doesn't apply. Under no circumstances should download from the
17+
internet, it is completely unreliable. See
18+
https://chocolatey.org/docs/community-packages-disclaimer#organizations
19+
to understand the limitations of a publicly available repository.
20+
21+
Community Repository?
22+
Have Distribution Rights?
23+
If you are the software vendor OR the software EXPLICITLY allows
24+
redistribution and the total nupkg size will be under 200MB, you
25+
have the option to embed the binaries directly into the package to
26+
provide the most reliable install experience. Put the binaries
27+
directly into the tools folder, use `$fileLocation` (`$file`/
28+
`$file64`) and `Install-ChocolateyInstallPackage`/
29+
`Get-ChocolateyUnzip` in tools\chocolateyInstall.ps1. Additionally,
30+
fill out the LICENSE and VERIFICATION file (see 3 below and those
31+
files for specifics).
32+
33+
NOTE: You can choose to download binaries at runtime, but be sure
34+
the download location will remain stable. See the next section.
35+
36+
Do Not Have Distribution Rights?
37+
- Note: Packages built this way cannot be 100% reliable, but it's a
38+
constraint of publicly available packages and there is little
39+
that can be done to change that. See
40+
https://chocolatey.org/docs/community-packages-disclaimer#organizations
41+
to better understand the limitations of a publicly available
42+
repository.
43+
Download Location is Publicly Available?
44+
You will need to download the runtime files from their official
45+
location at runtime. Use `$url`/`$url64` and
46+
`Install-ChocolateyPackage`/`Install-ChocolateyZipPackage` in
47+
tools\chocolateyInstall.ps1.
48+
Download Location is Not Publicly Available?
49+
Stop here, you can't push this to the community repository. You
50+
can ask the vendor for permission to embed, then include a PDF of
51+
that signed permission directly in the package. Otherwise you
52+
will need to seek alternate locations to non-publicly host the
53+
package.
54+
Download Location Is Same For All Versions?
55+
You still need to point to those urls, but you may wish to set up
56+
something like Automatic Updater (AU) so that when a new version
57+
of the software becomes available, the new package version
58+
automatically gets pushed up to the community repository. See
59+
https://chocolatey.org/docs/automatic-packages#automatic-updater-au
60+
61+
2. Determine Package Type:
62+
63+
- Installer Package - contains an installer (everything in template is
64+
geared towards this type of package)
65+
- Zip Package - downloads or embeds and unpacks archives, may unpack
66+
and run an installer using `Install-ChocolateyInstallPackage` as a
67+
secondary step.
68+
- Portable Package - Contains runtime binaries (or unpacks them as a
69+
zip package) - cannot require administrative permissions to install
70+
or use
71+
- Config Package - sets config like files, registry keys, etc
72+
- Extension Package - Packages that add PowerShell functions to
73+
Chocolatey - https://chocolatey.org/docs/how-to-create-extensions
74+
- Template Package - Packages that add templates like this for `choco
75+
new -t=name` - https://chocolatey.org/docs/how-to-create-custom-package-templates
76+
- Other - there are other types of packages as well, these are the main
77+
package types seen in the wild
78+
79+
3. Fill out the package contents:
80+
81+
- tools\chocolateyBeforeModify.ps1 - remove if you have no processes
82+
or services to shut down before upgrade/uninstall
83+
- tools\LICENSE.txt / tools\VERIFICATION.txt - Remove if you are not
84+
embedding binaries. Keep and fill out if you are embedding binaries
85+
in the package AND pushing to the community repository, even if you
86+
are the author of software. The file becomes easier to fill out
87+
(does not require changes each version) if you are the software
88+
vendor. If you are building packages for internal use (organization,
89+
etc), you don't need these files as you are not subject to
90+
distribution rights internally.
91+
- tools\chocolateyUninstall.ps1 - remove if autouninstaller can
92+
automatically uninstall and you have nothing additional to do during
93+
uninstall
94+
- Readme.txt - delete this file once you have read over and used
95+
anything you've needed from here
96+
- nuspec - fill this out, then clean out all the comments (you may wish
97+
to leave the headers for the package vs software metadata)
98+
- tools\chocolateyInstall.ps1 - instructions in next section.
99+
100+
4. ChocolateyInstall.ps1:
101+
102+
- For embedded binaries - use `$fileLocation` (`$file`/`$file64`) and
103+
`Install-ChocolateyInstallPackage`/ `Get-ChocolateyUnzip`.
104+
- Downloading binaries at runtime - use `$url`/`$url64` and
105+
`Install-ChocolateyPackage` / `Install-ChocolateyZipPackage`.
106+
- Other needs (creating files, setting registry keys), use regular
107+
PowerShell to do so or see if there is a function already defined:
108+
https://chocolatey.org/docs/helpers-reference
109+
- There may also be functions available in extension packages, see
110+
https://chocolatey.org/packages?q=id%3A.extension for examples and
111+
availability.
112+
- Clean out the comments and sections you are not using.
113+
114+
5. Test the package to ensure install/uninstall work appropriately.
115+
There is a test environment you can use for this -
116+
https://github.com/chocolatey/chocolatey-test-environment
117+
118+
6. Learn more about Chocolatey packaging - go through the workshop at
119+
https://github.com/ferventcoder/chocolatey-workshop
120+
You will learn about
121+
- General packaging
122+
- Customizing package behavior at runtime (package parameters)
123+
- Extension packages
124+
- Custom packaging templates
125+
- Setting up an internal Chocolatey.Server repository
126+
- Adding and using internal repositories
127+
- Reporting
128+
- Advanced packaging techniques when installers are not friendly to
129+
automation
130+
131+
7. Delete this file.
10.5 KB
Binary file not shown.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
3+
<metadata>
4+
<id>quick-picture-viewer</id>
5+
<version>3.0.4</version>
6+
<packageSourceUrl>https://github.com/ModuleArt/quick-picture-viewer/chocolatey/quick-picture-viewer</packageSourceUrl>
7+
<owners>Module Art</owners>
8+
<title>Quick Picture Viewer</title>
9+
<authors>Module Art</authors>
10+
<projectUrl>https://moduleart.github.io/quick-picture-viewer/</projectUrl>
11+
<iconUrl>https://github.com/ModuleArt/quick-picture-viewer/blob/master/quick-picture-viewer/resources/imgs/picture512.png</iconUrl>
12+
<copyright>Copyright © 2021 Module Art</copyright>
13+
<licenseUrl>https://github.com/ModuleArt/quick-picture-viewer/blob/master/LICENSE</licenseUrl>
14+
<requireLicenseAcceptance>true</requireLicenseAcceptance>
15+
<projectSourceUrl>https://github.com/ModuleArt/quick-picture-viewer</projectSourceUrl>
16+
<bugTrackerUrl>https://github.com/ModuleArt/quick-picture-viewer/issues</bugTrackerUrl>
17+
<tags>quick picture viewer image foss lightweight photo editor module art</tags>
18+
<summary>Lightweight, versatile desktop image viewer for Windows</summary>
19+
<description>Lightweight, versatile desktop image viewer for Windows. The best replacement for the default Windows photo viewer.</description>
20+
<releaseNotes>https://github.com/ModuleArt/quick-picture-viewer/releases</releaseNotes>
21+
</metadata>
22+
<files>
23+
<file src="tools\**" target="tools" />
24+
</files>
25+
</package>
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+

2+
Note: Include this file if including binaries you have the right to distribute.
3+
Otherwise delete. this file.
4+
5+
===DELETE ABOVE THIS LINE AND THIS LINE===
6+
7+
From: <insert applicable license url here>
8+
9+
LICENSE
10+
11+
<Insert License Here>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+

2+
Note: Include this file if including binaries you have the right to distribute.
3+
Otherwise delete. this file. If you are the software author, you can change this
4+
mention you are the author of the software.
5+
6+
===DELETE ABOVE THIS LINE AND THIS LINE===
7+
8+
VERIFICATION
9+
Verification is intended to assist the Chocolatey moderators and community
10+
in verifying that this package's contents are trustworthy.
11+
12+
<Include details of how to verify checksum contents>
13+
<If software vendor, explain that here - checksum verification instructions are optional>

0 commit comments

Comments
 (0)