Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brogers5/chocolatey-package-xsplit-broadcaster

Chocolatey package for XSplit Broadcaster.
https://github.com/brogers5/chocolatey-package-xsplit-broadcaster

au au-packages chocolatey chocolatey-automatic chocolatey-packages package packaging powershell powershell-script powershell-scripting software software-management windows xsplit

Last synced: about 5 hours ago
JSON representation

Chocolatey package for XSplit Broadcaster.

Awesome Lists containing this project

README 

        
#  Chocolatey Package: [XSplit Broadcaster](https://community.chocolatey.org/packages/xsplit-broadcaster)



[![Latest package version shield](https://img.shields.io/chocolatey/v/xsplit-broadcaster.svg?include_prereleases)](https://community.chocolatey.org/packages/xsplit-broadcaster)

[![Total package download count shield](https://img.shields.io/chocolatey/dt/xsplit-broadcaster.svg)](https://community.chocolatey.org/packages/xsplit-broadcaster)



## Install



[Install Chocolatey](https://chocolatey.org/install), and run the following command to install the latest approved stable version from the Chocolatey Community Repository:



```shell

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](https://github.com/brogers5/chocolatey-package-xsplit-broadcaster/releases). The `nupkg` can be installed from the current directory (with dependencies sourced from the Community Repository) as follows:



```shell

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](https://chocolatey.org/install), clone this repository, and run the following command in the cloned repository:



```shell

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](https://github.com/chocolatey/choco/issues/1174). 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](https://github.com/majkinetor/au). If it is outdated by more than a few days, please [open an issue](https://github.com/brogers5/chocolatey-package-xsplit-broadcaster/issues).



### 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:



```shell

git clone [email protected]: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](https://github.com/majkinetor/au-packages-template)):



```shell

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](https://community.chocolatey.org/packages/vt-cli) and [configure an API key](https://virustotal.github.io/vt-cli/#configuring-your-api-key). An API key can be [procured for free with a VirusTotal account](https://docs.virustotal.com/docs/please-give-me-an-api-key).



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](https://docs.chocolatey.org/en-us/features/virus-check), which by default is [enabled and configured for VirusTotal integration](https://docs.chocolatey.org/en-us/features/virus-check#virustotal).



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](https://github.com/chocolatey/home/issues/247)), 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](https://docs.chocolatey.org/en-us/features/virus-check#what-if-virustotal-doesnt-have-results-for-a-binary).



### 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:



```powershell

.\update.ps1 -IncludeStream 'Stable'

```



```powershell

.\update.ps1 -IncludeStream 'm54'

```



Before submitting a pull request, please [test the package](https://docs.chocolatey.org/en-us/community-repository/moderation/package-verifier#steps-for-each-package) using the latest [Chocolatey Testing Environment](https://github.com/chocolatey-community/chocolatey-test-environment) first.