Skip to content

Latest commit

 

History

History
97 lines (67 loc) · 5.36 KB

README.md

File metadata and controls

97 lines (67 loc) · 5.36 KB
Raw

What is this?

This automates some tasks involved in maintaining a private Chocolatey repository, specifically focusing on repositories hosted on Nexus.

  • Checking for packages that out of date in a Nexus NuGet repository, and updating them.

  • Moving packages from a Nexus proxy repository to a hosted Nexus repository.

  • Internalizing/Recompiling select Chocolatey packages, otherwise known as embedding the binaries inside the package.

Requirements

  • PowerShell v5.1+ (Windows and Linux)
  • choco installed and on your path
  • A nuget repository or a folder with .nupkgs to internalize. Sonatype Nexus is the most widely tested repository.
    • Drop path's are available with ProGet only
    • RepoMove and RepoSearch are Sonatype Nexus only

Setup

  • Clone this repository
  • Chocolatey is required, make sure that it is installed and working properly.
  • Copy *.xml.template files to *.xml and edit them.
    • See the files for comments about each of the options.
  • The path to each of these files can be specified as such (in order of precedence):
    1. Manually with the -configXML, -internalizedXML, and -repoCheckXML arguments to the locations of these files.
    2. Manually with the -folderXML argument which specifies the location to a folder with all three files.
    3. Then if neither of those is specified, the folder that contains the choco-remixer.psm1 module will be checked.
    4. Then the parent folder of the module will be checked.
    5. Finally, the $env:AppData\choco-remixer folder will be checked ($env:HOME/config/choco-remixer on Linux)
  • If you are using the automatic pushing (pushPkgs), make sure choco has the appropriate apikey setup for that URL.
  • It is a good idea to put the xml files in a git repository.

Operation

  • Import the choco-remixer PowerShell module

  • Run Invoke-InternalizeChocoPkg

  • If you have useDropPath and pushPkgs disabled, the internalized packages are located inside the specified workDir.

  • If you have writePerPkgs disabled, add the package versions to internalized.xml under the correct IDs. Otherwise, it will try to internalize them again.

  • If continuously re-running for development or bug fixing, use the -skipRepoCheck switch, so as to not get rate limited by chocolatey.org

Adding support for more packages

See ADDING_PACKAGES.md (in progress) for more information on how to add support for another package. PRs welcome, see CONTRIBUTING.md for more information

Otherwise, open an issue to see if there is someone willing to add support.

Why have internalization functionality?

  • Because relying on software to be available at a specific URL on the internet in perpetuity is not a good idea for a number of reasons.
  • Manually downloading and internalizing for each individual package version is huge amount of work for any quantity of packages.
  • Allows (most) packages to work on offline/air gapped environments.
  • Makes install a previous version always possible. Some software vendors only have their latest version available to download, in which case old package versions break.

Comparison to the Chocolatey For Business Internalization Functionality

In comparison with the Chocolatey business license that has automated internalization functionality, choco-remixer:

  • Is free and open source software
  • Is available at no cost.
  • Does not require a licensed Chocolatey installation to install the internalized packages. Packages internalized with the licensed internalizer stop working if you license lapses.
  • Validates checksums of downloaded binaries (.nupkgs included) and warns if checksums are not available in the package.
  • Is available for Linux systems.

However, choco-remixer:

  • Does not have any SLA or on-call support.
  • Requires each package to be supported explicitly
  • Is in general more brittle (internalization is more likely to fail loudly if a package changes)
  • Requires more set-up and configuration
  • Is not stable software (yet)

Caveats

  • This is not at a stable release. Things may break, feel free to open an issue if I broke something.
  • Packages can change on the Community Repository, please open an issue if a package is broken.
  • Support must be added individually for each package.
  • Linux support is not as throughly tested, open an issue if there are any incompatibilities.

Specific TODOs

  • Add support for internalizing package icons
  • Comment based help for all public functions, specifically in Edit-InstallChocolateyPackage (platyps?)
  • Module metadata creation, module install, other helper scripts
  • Complete the components for module, and publish the module (PowerShell gallery)
  • Add Pester tests
  • Add generic functions for archive, portable download and vscode extension packages.

Continuous TODOs

  • Generalize and factor out repeated code into functions.
  • Continue adding support for more packages

Progress