brogers5 / chocolatey-package-xsplit-broadcaster

Chocolatey package for XSplit Broadcaster.

Chocolatey Package: XSplit Broadcaster

Install

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

choco install xsplit-broadcaster --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 xsplit-broadcaster --source="'.;https://community.chocolatey.org/api/v2/'"

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

Build

Install Chocolatey, clone this repository, and run the following command in the cloned repository:

choco pack

A successful build will create xsplit-broadcaster.w.x.y.z.nupkg, where w.x.y.z should be the Nuspec's normalized version value at build time.

Note

As of Chocolatey v2.0.0, leading zeros will no longer be used/honored within version numbers. Legacy package versions that contain these will be normalized to remove them from the resulting filename. Going forward, version will be normalized accordingly for behavior consistency between v1 and v2 Chocolatey releases.

Note

Chocolatey package builds are non-deterministic. Consequently, an independently built package's checksum will not match that of the officially published package.

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 Setup

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

git clone [e-mail]:brogers5/chocolatey-package-xsplit-broadcaster.git xsplit-broadcaster

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

mklink /J xsplit-broadcaster ..\chocolatey-package-xsplit-broadcaster

VirusTotal Setup

While not strictly necessary to produce a working package, it's recommended to install VirusTotal's CLI and configure an API key. An API key can be procured for free with a VirusTotal account.

This should enable automated submission of the installer binary to VirusTotal, which would improve the user experience for Chocolatey Pro+ users. They have access to Chocolatey's Runtime Malware Protection feature, which by default is enabled and configured for VirusTotal integration.

Normally, the Community Repository's Package Scanner service would upload the installer binary to VirusTotal, as a prerequisite to the moderation process's Scan Testing step. Unfortunately, the package is currently incompatible with it (due to the installer binary exceeding the current 200MB file size limit), and will therefore fail to submit the installer binary.

As new XSplit Broadcaster releases are unlikely to have been scanned prior to an updated package's publication, this would avoid burdening users with a run-time prompt to optionally upload the installer binary to VirusTotal for scanning.

Execution and Testing

Once everything is set up, 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. 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 'm53'

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