Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More

Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

Downloads:

48,253

Downloads of v 0.0.1:

48,253

Last Update:

28 Apr 2022

Package Maintainer(s):

Software Author(s):

  • Bill Curran

Tags:

bcurran3 choco win10 win11 extension extensions maintainers

Chocolatey OS Dependency Extension

  • 1
  • 2
  • 3

0.0.1 | Updated: 28 Apr 2022

Downloads:

48,253

Downloads of v 0.0.1:

48,253

Maintainer(s):

Software Author(s):

  • Bill Curran

Chocolatey OS Dependency Extension 0.0.1

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Chocolatey OS Dependency Extension, run the following command from the command line or from PowerShell:

>

To upgrade Chocolatey OS Dependency Extension, run the following command from the command line or from PowerShell:

>

To uninstall Chocolatey OS Dependency Extension, run the following command from the command line or from PowerShell:

>

Deployment Method:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade chocolatey-os-dependency.extension -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade chocolatey-os-dependency.extension -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install chocolatey-os-dependency.extension
  win_chocolatey:
    name: chocolatey-os-dependency.extension
    version: '0.0.1'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'chocolatey-os-dependency.extension' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '0.0.1'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller chocolatey-os-dependency.extension
{
    Name     = "chocolatey-os-dependency.extension"
    Version  = "0.0.1"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'chocolatey-os-dependency.extension':
  ensure   => '0.0.1',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved by moderator Windos on 04 May 2022.

Description

Screenshot of chocolatey-os-dependency.extension example

PURPOSE:

chocolatey-os-dependency.extension provides easy to remember functions for package creators/maintainers to verify an OS version requirement during package installation. The OS and build versions are checked and if found not compatible, the package installation is aborted. The functions are named Confirm-WinX; where X can be 11, 10, 81, 80, 8, or 7. Additionally the Confirm-WinX function can be used with a minimum build number requirement.

FUNCTIONS:

  • Confirm-Win11 - Checks for Windows 11 and aborts package install if not. Default build 22000.
  • Confirm-Win10 - Checks for Windows 10 (or 11) and aborts package install if not. Default build 10240.
  • Confirm-Win81 - Checks for Windows 8.1 and aborts package install if not. Default build 9600.
  • Confirm-Win80 - Checks for Windows 8.0 and aborts package install if not. Default build 9200.
  • Confirm-Win8 - Checks for Windows 8.0 or 8.1 and aborts package install if not. Default build 9200.
  • Confirm-Win7 - Checks for Windows 7 and aborts package install if not. Default build 7601.
  • Confirm-WinMinimumBuild - Checks for a Windows minimum build and aborts package install if not. (Built for the future!)
  • Confirm-WinRequiredBuild - Checks for a Windows specific build and aborts package install if not. (Built for the future!)

USAGE:

  • Add Confirm-Win10 to your chocolateyInstall.ps1 script before Install-ChocolateyPackage to abort the install if Windows 10 (or 11) is not present.
  • Add Confirm-Win10 19041 to your chocolateyInstall.ps1 script before Install-ChocolateyPackage to abort the install if Windows 10 build 19041 (version 2004/Vibranium) or higher is not present.
  • Add Confirm-Win11 or Confirm-Win11 22000 or Confirm-WinMinimumBuild 22000 to your chocolateyInstall.ps1 script before Install-ChocolateyPackage to abort the install if Windows 11 is not present.
  • Add Confirm-WinRequiredBuild 20348 to your chocolateyInstall.ps1 script before Install-ChocolateyPackage to abort install if Windows Server 2022 is not present.
  • Consult this List of Microsoft Windows versions to reference build numbers.

Click here to Patreon-ize the package maintainer.



extensions\chocolatey-os-dependency.ps1
# chocolatey-os-dependency.extension v0.0.1 (04-28-2022) by Bill Curran AKA BCURRAN3 - public domain

# Confirms OS is Windows 11 and aborts if not. If no build number is specified, it defaults to the initial release build.
# Can be sent a particular build # to check as minimum.
# REF: https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
function Confirm-Win11{
  Param(
    [Parameter(Mandatory=$false,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )
  
$OSMajor=[Environment]::OSVersion.Version.Major
$OSBuild=[Environment]::OSVersion.Version.Build
if (!$ReqBuild) {$ReqBuild = 22000}
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild Minimum Required Build = $ReqBuild -Foreground Magenta
if ($OSMajor -eq 10 -and $OSBuild -ge 22000 -and $OSBuild -ge $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows 11 Build $ReqBuild or higher required." -Foreground Red
		 throw
		 }
}

# Confirms OS is Windows 10 (or 11) and aborts if not. If no build number is specified, it defaults to the initial release build.
# Can be sent a particular build # to check as minimum.
# REF: https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
function Confirm-Win10{
  Param(
    [Parameter(Mandatory=$false,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )

$OSMajor=[Environment]::OSVersion.Version.Major
$OSBuild=[Environment]::OSVersion.Version.Build
if (!$ReqBuild) {$ReqBuild = 10240}
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild Minimum Required Build = $ReqBuild -Foreground Magenta
if ($OSMajor -eq 10 -and $OSBuild -ge 10240 -and $OSBuild -ge $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows 10 Build $ReqBuild or higher required." -Foreground Red
		 throw
		 }
}

# Confirms OS is Windows 8.1 and aborts if not.
function Confirm-Win81{
  Param(
    [Parameter(Mandatory=$false,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )
  
$OSMajor=[Environment]::OSVersion.Version.Major
$OSMinor=[Environment]::OSVersion.Version.Minor
$OSBuild=[Environment]::OSVersion.Version.Build
if (!$ReqBuild) {$ReqBuild = 9600}
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild Minimum Required Build = $ReqBuild -Foreground Magenta
if ($OSMajor -eq 6 -and $minor -eq 3 -and $OSBuild -ge 9600 -and $OSBuild -ge $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows 8.1 Build $ReqBuild or higher required." -Foreground Red 
		 throw
		 }
}

# Confirms OS is Windows 8.0 and aborts if not.
function Confirm-Win80{
  Param(
    [Parameter(Mandatory=$false,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )
  
$OSMajor=[Environment]::OSVersion.Version.Major
$OSMinor=[Environment]::OSVersion.Version.Minor
$OSBuild=[Environment]::OSVersion.Version.Build
if (!$ReqBuild) {$ReqBuild = 9200}
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild Minimum Required Build = $ReqBuild -Foreground Magenta
if ($OSMajor -eq 6 -and $minor -eq 2 -and $OSBuild -ge 9200 -and $OSBuild -ge $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows 8.0 Build $ReqBuild or higher required." -Foreground Red 
		 throw
		 }
}

# Confirms OS is Windows 8.0 or 8.1 and aborts if not.
function Confirm-Win8{
  Param(
    [Parameter(Mandatory=$false,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )
  
$OSMajor=[Environment]::OSVersion.Version.Major
$OSBuild=[Environment]::OSVersion.Version.Build
if (!$ReqBuild) {$ReqBuild = 9200}
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild Minimum Required Build = $ReqBuild -Foreground Magenta
if ($OSMajor -eq 6 -and $OSBuild -ge 9200 -and $OSBuild -ge $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows 8 Build $ReqBuild or higher required." -Foreground Red 
		 throw
		 }
}

# Confirms OS is Windows 7 and aborts if not.
function Confirm-Win7{
  Param(
    [Parameter(Mandatory=$false,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )
  
$OSMajor=[Environment]::OSVersion.Version.Major
$OSMinor=[Environment]::OSVersion.Version.Minor
$OSBuild=[Environment]::OSVersion.Version.Build
if (!$ReqBuild) {$ReqBuild = 7601}
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild Minimum Required Build = $ReqBuild -Foreground Magenta
if ($OSMajor -eq 6 -and $minor -lt 1 -and $OSBuild -ge 7601 -and $OSBuild -ge $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows 7 Build $ReqBuild or higher required." -Foreground Red 
		 throw
		 }
}

# Confirms Windows has a minimum build number and aborts if not. Not major version specific.
function Confirm-WinMinimumBuild{
  Param(
    [Parameter(Mandatory=$true,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )
  
$OSMajor=[Environment]::OSVersion.Version.Major
$OSBuild=[Environment]::OSVersion.Version.Build
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild Minimum Required Build = $ReqBuild -Foreground Magenta
if ($OSBuild -ge $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows Build $ReqBuild or higher required." -Foreground Red
		 throw
		 }
}

# Confirms Windows is build x and aborts if not. Not major version specific.
function Confirm-WinRequiredBuild{
  Param(
    [Parameter(Mandatory=$true,
    ValueFromPipeline=$true)]
    [int]
    $ReqBuild
  )
  
$OSMajor=[Environment]::OSVersion.Version.Major
$OSBuild=[Environment]::OSVersion.Version.Build
Write-Host OS Dependency Check: OSMajor = $OSMajor OSBuild = $OSBuild MRequired Build = $ReqBuild -Foreground Magenta
if ($OSBuild -eq $ReqBuild) {
	return
	 } else {
		 Write-Host "WARNING:   ** Windows Build $ReqBuild required." -Foreground Red
		 throw
		 }
}
extensions\chocolatey-os-dependency.psm1
# chocolatey-os-dependency.extension v0.0.1 (04-28-2022) by Bill Curran AKA BCURRAN3 - public domain

$scriptRoot = Split-Path -Path $MyInvocation.MyCommand.Definition
 
$publicFunctions = @(
    'Confirm-Win11',
	'Confirm-Win10'
	'Confirm-Win81',
	'Confirm-Win80',
	'Confirm-Win8',
	'Confirm-Win7',
	'Confirm-WinMinimumBuild',
	'Confirm-WinRequiredBuild'
	
)
 
Get-ChildItem -Path "$scriptRoot\*.ps1" | ForEach-Object { . $_ }
Export-ModuleMember -Function $publicFunctions

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status

CHANGE LOG:

  • 0.0.1 - initial release

ROADMAP:

  • Add Windows Server OS Checking
  • I am open to any useful suggestions/additions! Please open a GitHub issue if so.

This package has no dependencies.

Discussion for the Chocolatey OS Dependency Extension Package

Ground Rules:

  • This discussion is only about Chocolatey OS Dependency Extension and the Chocolatey OS Dependency Extension package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Chocolatey OS Dependency Extension, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus