Skip to content
This repository has been archived by the owner on Oct 25, 2022. It is now read-only.

Update AUPackages

Paul Broadwith edited this page Jun 27, 2017 · 1 revision

Update-AUPackages

NAME

Update-AUPackages

SYNOPSIS

Update all automatic packages

SYNTAX

Update-AUPackages [[-Name] <String[]>] [[-Options] <OrderedDictionary>] [-NoPlugins] [<CommonParameters>]

DESCRIPTION

Function Update-AUPackages will iterate over update.ps1 scripts and execute each. If it detects
that a package is updated it will push it to the Chocolatey community repository.

The function will look for AU packages in the directory pointed to by the global variable au_root
or in the current directory if mentioned variable is not set.

For the push to work, specify your API key in the file 'api_key' in the script's directory or use
cached nuget API key or set environment variable '$Env:api_key'.

The function accepts many options via ordered HashTable parameter Options.

PARAMETERS

-Name <String[]>
    Filter package names. Supports globs.
    
    Required?                    false
    Position?                    1
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-Options <OrderedDictionary>
    Hashtable with options:
      Threads           - Number of background jobs to use, by default 10.
      Timeout           - WebRequest timeout in seconds, by default 100.
      UpdateTimeout     - Timeout for background job in seconds, by default 1200 (20 minutes).
      Force             - Force package update even if no new version is found.
      Push              - Set to true to push updated packages to Chocolatey community repository.
      PluginPath        - Additional path to look for user plugins. If not set only module integrated plugins will work
    
      Plugin            - Any HashTable key will be treated as plugin with the same name as the option name.
                          A script with that name will be searched for in the AU module path and user specified path.
                          If script is found, it will be called with splatted HashTable passed as plugin parameters.
    
                          To list default AU plugins run:
    
                                ls "$(Split-Path (gmo au -list).Path)\Plugins\*.ps1"
    
      BeforeEach        - User ScriptBlock that will be called before each package and accepts 2 arguments: Name & Options.
                          To pass additional arguments, specify them as Options key/values.
      AfterEach         - Similar as above.
      Script            - Script that will be called before and after everything.
    
    Required?                    false
    Position?                    2
    Default value                @{}
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-NoPlugins [<SwitchParameter>]
    Do not run plugins, defaults to global variable `au_NoPlugins`.
    
    Required?                    false
    Position?                    named
    Default value                $global:au_NoPlugins
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
<CommonParameters>
    This cmdlet supports the common parameters: Verbose, Debug,
    ErrorAction, ErrorVariable, WarningAction, WarningVariable,
    OutBuffer, PipelineVariable, and OutVariable. For more information, see 
    about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 

INPUTS

OUTPUTS

AUPackage[]


-------------------------- EXAMPLE 1 --------------------------

PS C:\>Update-AUPackages p* @{ Threads = 5; Timeout = 10 }

Update all automatic packages in the current directory that start with letter 'p' using 5 threads
and web timeout of 10 seconds.




-------------------------- EXAMPLE 2 --------------------------

PS C:\>$au_root = 'c:\chocolatey'; updateall @{ Force = $true }

Force update of all automatic ackages in the given directory.

RELATED LINKS

Update-Package 

NOTE: This documentation has been automatically generated from Get-Help Update-AUPackages -Full.