Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 3.77 KB

ReadMe.md

File metadata and controls

60 lines (37 loc) · 3.77 KB
Raw

Chocolatey Package: Twinkle Tray

Chocolatey package version Chocolatey package download count

Install

Install Chocolatey, and run the following command to install the latest approved stable version from the Chocolatey Community Repository:

choco install twinkle-tray --source="'https://community.chocolatey.org/api/v2'"

Alternatively, the packages as published on the Chocolatey Community Repository will also be mirrored on this repository's Releases page. The nupkg can be installed from the current directory (with dependencies sourced from the Community Repository) as follows:

choco install twinkle-tray --source="'.;https://community.chocolatey.org/api/v2/'"

This package also supports the project's pre-release builds. Opt into these with the --prerelease switch.

Build

Install Chocolatey, the Chocolatey Automatic Package Updater Module, and the PowerShellForGitHub PowerShell Module, then clone this repository.

Once cloned, simply run build.ps1. The binary is intentionally untracked to avoid bloating the repository, so the script will download the Twinkle Tray installer binary from the official distribution point, then packs everything together.

A successful build will create twinkle-tray.x.y.z.nupkg, where x.y.z should be the Nuspec's version value at build time.

Note that Chocolatey package builds are non-deterministic. Consequently, an independently built package will fail a checksum validation against officially published packages.

Update

This package should be automatically updated by the Chocolatey Automatic Package Updater Module. If it is outdated by more than a few days, please open an issue.

AU expects the parent directory that contains this repository to share a name with the Nuspec (twinkle-tray). Your local repository should therefore be cloned accordingly:

git clone [email protected]:brogers5/chocolatey-package-twinkle-tray.git twinkle-tray

Alternatively, a junction point can be created that points to the local repository (preferably within a repository adopting the AU packages template):

mklink /J twinkle-tray ..\chocolatey-package-twinkle-tray

Once created, simply run update.ps1 from within the created directory/junction point. Assuming all goes well, all relevant files should change to reflect the latest version available for the last stream that was built. This will also build a new package version using the modified files.

To limit the scope of update checks to a specific update channel, pass the -IncludeStream parameter with the desired Stream name:

.\update.ps1 -IncludeStream 'Stable'
.\update.ps1 -IncludeStream 'Beta'

Before submitting a pull request, please test the package using the Chocolatey Testing Environment first.