Ansible
PS DSC
Downloads:
98
Downloads of v 0.1.0:
98
Last Update:
22 Jul 2023
Package Maintainer(s):
Software Author(s):
- bcurran3
Tags:
bcurran3 unofficial choco cleaner rt cleanup hook
(unofficial) Choco Cleaner RT for ReadMe Files (Post-Install Hook)
- 1
- 2
- 3
0.1.0 | Updated: 22 Jul 2023
Downloads:
98
Downloads of v 0.1.0:
98
Maintainer(s):
Software Author(s):
- bcurran3
(unofficial) Choco Cleaner RT for ReadMe Files (Post-Install Hook) 0.1.0
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install (unofficial) Choco Cleaner RT for ReadMe Files (Post-Install Hook), run the following command from the command line or from PowerShell:
To upgrade (unofficial) Choco Cleaner RT for ReadMe Files (Post-Install Hook), run the following command from the command line or from PowerShell:
To uninstall (unofficial) Choco Cleaner RT for ReadMe Files (Post-Install Hook), run the following command from the command line or from PowerShell:
Deployment Method:
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
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
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
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download choco-cleaner-rt-readmes.hook --internalize --source=https://community.chocolatey.org/api/v2/ -
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'" - Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade choco-cleaner-rt-readmes.hook -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 choco-cleaner-rt-readmes.hook -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 choco-cleaner-rt-readmes.hook
win_chocolatey:
name: choco-cleaner-rt-readmes.hook
version: '0.1.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'choco-cleaner-rt-readmes.hook' do
action :install
source 'INTERNAL REPO URL'
version '0.1.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller choco-cleaner-rt-readmes.hook
{
Name = "choco-cleaner-rt-readmes.hook"
Version = "0.1.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'choco-cleaner-rt-readmes.hook':
ensure => '0.1.0',
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.
This package was approved by moderator Windos on 25 Jul 2023.
choco://choco-cleaner-rt-readmes.hook
To use choco:// protocol URLs, install (unofficial) choco:// Protocol support
Choco Cleaner RT for ReadMe Files deletes unnecessary files such as readme.md, credits.txt, etc.
Choco Cleaner RT (runtime/realtime - you choose) hooks are the natural evolution of my Choco-Cleaner script using hooks available in Chocolatey v1.2.0+. These hooks do micro cleansing by duplicating the features of Choco Cleaner before and after package installs, thus RT. No scheduling. No manually running anything. No need to edit a config file. Just install the choco-cleaner-rt-XXX.hook(s) you want. Choco Cleaner RT hooks run WHEN you install and update packages.
NOTES:
- Recovered disk space will not be as dramatic as when running Choco-Cleaner since Choco-Cleaner-RT will be running far more often and you'll see smaller results on a per package basis.
- Some Choco-Cleaner-RT micro cleansing happens on previously installed packages instead of the current one due to technical restrictions; i.e. choco-cleaner-rt-ignores.hook can not delete .ignore files from the current package or Chocolatey will make shims for everything the packager didn't want shimmed.
- File deletion logging and toggling the displayed info off are possible via a config, see choco-cleaner-rt for more info.
- A few features of Choco-Cleaner are not going to be supported by CCRT such as orphaned shim checking and deleting of Chocolatey .log and .old files; if you want these features please use Choco-Cleaner.
Choco Cleaner RT Collection:
- choco-cleaner-rt - installs the most desirable hooks as dependencies and the optional config file
- choco-cleaner-rt-archives.hook
- choco-cleaner-rt-chocolateycache.hook
- choco-cleaner-rt-desktopicons.hook
- choco-cleaner-rt-dotchocolatey.hook
- choco-cleaner-rt-ignores.hook
- choco-cleaner-rt-libbad.hook
- choco-cleaner-rt-libbkp.hook
- choco-cleaner-rt-licenses.hook
- choco-cleaner-rt-msinstallers.hook
- choco-cleaner-rt-nugetcache.hook
- choco-cleaner-rt-nupkgs.hook
- choco-cleaner-rt-readmes.hook
- choco-cleaner-rt-startmenuicons.hook
If you find Choco-Cleaner-RT useful, and I suspect you will, please consider donating: https://www.paypal.me/bcurran3donations or become a patron at https://www.patreon.com/bcurran3
$ErrorActionPreference = 'Continue'
# Choco-Cleaner-RT-readmes.hook v0.1.0 Copyleft 2023 by Bill Curran AKA BCURRAN3
# LICENSE: GNU GPL v3 - https://www.gnu.org/licenses/gpl.html
# Suggestions? Problems? Open a GitHub issue at https://github.com/bcurran3/ChocolateyPackages/issues
$HookName = "Choco-Cleaner-RT (readmes)"
$ConfigFile = "$(Get-ToolsLocation)\BCURRAN3\choco-cleaner-rt.config"
$LogFile = "$(Get-ToolsLocation)\BCURRAN3\choco-cleaner-rt.log"
$DebugInfo = $False
$DisplayInfo = $True
$LogInfo = $False
$readme_types = @( "credits.txt","readme.txt","*.md" )
if (Test-Path "$ConfigFile"){
[xml]$Config = Get-Content "$ConfigFile"
if ($Config.Settings.Preferences.DebugInfo -eq "true") {$DebugInfo=$True} else {$DebugInfo=$False}
if ($Config.Settings.Preferences.DisplayInfo -eq "true") {$DisplayInfo=$True} else {$DisplayInfo=$False}
if ($Config.Settings.Preferences.LogInfo -eq "true") {$LogInfo=$True} else {$LogInfo=$False}
}
if ($DebugInfo) { Write-Host " ** Running $HookName..." -Foreground Yellow }
if (!(Test-Path "$(Get-ToolsLocation)\BCURRAN3")) {$LogInfo=$False}
function Add2Log {
Param ( [string]$comment )
if ($LogInfo) {
Write-Output "$(Get-Date) [INFO ] $comment" >> "$LogFile"
}
}
if (Test-ProcessAdminRights) {
$GotReadMeFiles=Get-ChildItem -Path $env:packageFolder -Recurse -Include $readme_types -ErrorAction SilentlyContinue
$ReadMeFiles=$GotReadMeFiles.count
if ($ReadMeFiles -ge 1){
$GotReadMeFiles | ForEach-Object {$GotReadMeFilesSize=$GotReadMeFilesSize + $_.length}
$GotReadMeFilesSize = $(($GotReadMeFilesSize/1kb).ToString('N0'))
Remove-Item -Path $env:packageFolder -Recurse -Include $readme_types -ErrorAction SilentlyContinue
$GotReadMeFiles.fullname | ForEach-Object {Add2Log "DELETED: $_"}
if ($DisplayInfo){
Write-Host " ** $HookName`: Deleted $ReadMeFiles unnecessary Chocolatey package embedded readme files saving $GotReadMeFilesSize KB." -Foreground Green
}
}
} else {
if ($DisplayInfo){ Write-Host " ** $HookName requires admin rights." } -Foreground Yellow
}
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.
Copyleft Bill Curran
CHANGELOG:
- 0.1.0 - initial release
-
- chocolatey (≥ 1.2.0)
Ground Rules:
- This discussion is only about (unofficial) Choco Cleaner RT for ReadMe Files (Post-Install Hook) and the (unofficial) Choco Cleaner RT for ReadMe Files (Post-Install Hook) 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 Cleaner RT for ReadMe Files (Post-Install Hook), 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.