Downloads:

804

Downloads of v 0.0.1.1:

646

Last Update:

09 May 2018

Package Maintainer(s):

Software Author(s):

  • bcurran3

Tags:

bcurran3 unofficial choco licensed c4b optimize schtasks scheduled task

(unofficial) Choco Optimize at (Task)

0.0.1.1 | Updated: 09 May 2018

Downloads:

804

Downloads of v 0.0.1.1:

646

Maintainer(s):

Software Author(s):

  • bcurran3

(unofficial) Choco Optimize at (Task) 0.0.1.1

This Package Contains an Exempted Check

1 Test Passing and 1 Exempted Test


Validation Testing Passed


Verification Testing Exempt:

automated testing environment is not configured with a Chocolatey licensed edition

To install (unofficial) Choco Optimize at (Task), run the following command from the command line or from PowerShell:

>

To upgrade (unofficial) Choco Optimize at (Task), run the following command from the command line or from PowerShell:

>

To uninstall (unofficial) Choco Optimize at (Task), run the following command from the command line or from PowerShell:

>

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

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • 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://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. Enter your internal repository url

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

4. Choose your deployment method:


choco upgrade choco-optimize-at -y --source="'STEP 3 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 choco-optimize-at -y --source="'STEP 3 URL'" 
$exitCode = $LASTEXITCODE

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

Exit $exitCode

- name: Ensure choco-optimize-at installed
  win_chocolatey:
    name: choco-optimize-at
    state: present
    version: 0.0.1.1
    source: STEP 3 URL

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

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'choco-optimize-at' do
  action    :install
  version  '0.0.1.1'
  source   'STEP 3 URL'
end

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


Chocolatey::Ensure-Package
(
    Name: choco-optimize-at,
    Version: 0.0.1.1,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller choco-optimize-at
{
   Name     = 'choco-optimize-at'
   Ensure   = 'Present'
   Version  = '0.0.1.1'
   Source   = 'STEP 3 URL'
}

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


package { 'choco-optimize-at':
  provider => 'chocolatey',
  ensure   => '0.0.1.1',
  source   => 'STEP 3 URL',
}

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


salt '*' chocolatey.install choco-optimize-at version="0.0.1.1" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator gep13 on 11 May 2018.

Description

##choco-optimize-at periodically reduces the size of downloaded Chocolatey .nupkg package files thus saving HDD space. This package creates a Windows Scheduled Task to run "choco optimize" at a time you specify.

###WHO IS THIS FOR?
choco-optimize-at is designed for Chocolatey Pro and Chocolatey Business licensed users who want to automate optimization of storage space used by their Chocolatey .nupkg files.

###INSTRUCTIONS:
You can install choco-optimize-at with multiple parameters to make it run "choco optimize" daily or weekly at your preferred time. If you enter no parameters at all, choco-optimize-at will default to run "choco optimize" at 5 AM every SUNDAY. When entering the TIME parameter, use "Military Time." When entering the DAILY or WEEKLY parameter you can actually use anything, "yes" just makes sense though. When using the WEEKLY parameter, DAYS are entered as MON, TUE, WED, THU, FRI, SAT, or SUN. Not entering the correct format will fail the install. Please see the examples below.

###INSTALL EXAMPLES:

  • choco install choco-optimize-at - optimizes packages on SUNDAYS at 5 AM. (My preference!)
  • choco install choco-optimize-at --params "'/TIME:23:00'" - optimizes packages on SUNDAYS at 11 PM
  • choco install choco-optimize-at --params "'/DAILY:yes /TIME:06:00'" - optimizes packages daily at 6 AM
  • choco install choco-optimize-at --params "'/WEEKLY:yes /DAY:SAT /TIME:01:00'" - optimizes packages on SATURDAYS at 1 AM

####A NOTE ON DEFAULTS:

  • If you don't specify any parameters, choco-optimize-at defaults to running every Sunday at 5 AM. (My preference!) This default time was chosen to be compatible with with default run times used by choco-upgrade-all-at and choco-persistent-packages.
  • Not specifying a time will always default to 5 AM.
  • When WEEKLY is specified but a DAY isn't, default first run will be a week from installation date; i.e. next week on whatever day of the week you installed the package.

PACKAGE NOTES


tools\.SkipAutoUninstaller
 
tools\ChocolateyInstall.ps1
$packageName  = 'choco-optimize-at'
$pp           = Get-PackageParameters
$CheckLicense = "$env:ChocolateyInstall\license\chocolatey.license.xml"

if (Test-Path $CheckLicense){
    Write-Host Chocolatey license file found. Thanks for supporting Chocolatey! -foreground green
    } else {
      Write-Host Chocolatey license file NOT found. You need to be a Chocolatey Pro or Business customer to use this package. See https://chocolatey.org/pricing for more information. -foreground red
	  throw
    }
	
$GotTask = (&schtasks /query /tn choco-optimize-at) 2> $null 
if ($GotTask -ne $null){
     Write-Host "Existing choco-optimize-at scheduled task found. Keeping existing scheduled task." -foreground magenta -background blue
	 Write-Host "If you want to change the task runtime, uninstall and reinstall the package.     " -foreground magenta -background blue
     exit
   }
   
Write-Host "" 	
Write-Host "choco-optimize-at Summary:" -foreground magenta

if ($pp["TIME"] -eq $null -or $pp["TIME"] -eq ''){
      Write-Host " * TIME NOT specified, defaulting to 5 AM." -foreground magenta
	  $RunTime = "05:00"
    } else {
	  $RunTime = $pp["TIME"]
	  Write-Host " * TIME specified as $TIME." -foreground magenta
    } 
	
if (($pp["DAILY"] -eq $null -or $pp["DAILY"] -eq '') -and ($pp["WEEKLY"] -eq $null -or $pp["WEEKLY"] -eq '')){
      Write-Host " * DAILY NOT specified." -foreground magenta
      Write-Host " * WEEKLY NOT specified." -foreground magenta	  
      Write-Host " * Defaulting to WEEKLY running of ""choco-optimize-at"" at $RunTime on Sundays." -foreground magenta -background blue
      SchTasks /CREATE /SC WEEKLY /D SUN /RU SYSTEM /RL HIGHEST /TN choco-optimize-at /TR "choco optimize" /ST $RunTime /F
	  SchTasks /query /tn choco-optimize-at
 	  exit
    }
		  
if ($pp["DAILY"] -eq $null -or $pp["DAILY"] -eq ''){
       Write-Host " * DAILY NOT specified." -foreground magenta
    } else {
	   Write-Host " * DAILY specified." -foreground magenta
	   SchTasks /CREATE /SC DAILY /RU SYSTEM /RL HIGHEST /TN choco-optimize-at /TR "choco optimize" /ST $RunTime /F
	   SchTasks /query /tn choco-optimize-at
	   exit
	   }
		  
if ($pp["WEEKLY"] -eq $null -or $pp["WEEKLY"] -eq ''){
       Write-Host " * WEEKLY NOT specified." -foreground magenta
     } else {
	   Write-Host " * WEEKLY specified." -foreground magenta
       if ($pp["DAY"] -eq $null -or $pp["DAY"] -eq ''){
            Write-Host " * DAY NOT specified, defaulting to SUNDAY." -foreground magenta
            SchTasks /CREATE /SC WEEKLY /D SUN /RU SYSTEM /RL HIGHEST /TN choco-optimize-at /TR "choco optimize" /ST $RunTime /F
			SchTasks /query /tn choco-optimize-at
        } else {
		    $RunDay = $pp["DAY"]
            Write-Host " * DAY specified as $RunDay." -foreground magenta
		    SchTasks /CREATE /SC WEEKLY /D $pp["DAY"] /RU SYSTEM /RL HIGHEST /TN choco-optimize-at /TR "choco optimize" /ST $RunTime /F
			SchTasks /query /tn "choco-optimize-at"
	    }
	}
tools\ChocolateyUninstall.ps1
$packageName = 'choco-optimize-at'

SchTasks /Delete /TN choco-optimize-at /F

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.

Version Downloads Last Updated Status
(unofficial) Choco Optimize at (Task) 0.0.1 158 Tuesday, April 24, 2018 Approved

0.0.1.1 - removed unintentional forgotten code that caused WEEKLY with no other parameters to error out.

Discussion for the (unofficial) Choco Optimize at (Task) Package

Ground Rules:

  • This discussion is only about (unofficial) Choco Optimize at (Task) and the (unofficial) Choco Optimize at (Task) 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 (unofficial) Choco Optimize at (Task), 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