https://github.com/thecakeisnaoh/choco-remixer
Manage your private repository of Chocolatey packages
https://github.com/thecakeisnaoh/choco-remixer
chocolatey chocolatey-packages nexus
Last synced: 6 months ago
JSON representation
Manage your private repository of Chocolatey packages
- Host: GitHub
- URL: https://github.com/thecakeisnaoh/choco-remixer
- Owner: TheCakeIsNaOH
- License: apache-2.0
- Created: 2020-03-19T02:21:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T01:06:18.000Z (8 months ago)
- Last Synced: 2025-04-02T22:06:35.379Z (7 months ago)
- Topics: chocolatey, chocolatey-packages, nexus
- Language: PowerShell
- Homepage:
- Size: 1.12 MB
- Stars: 52
- Watchers: 7
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## 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](https://chocolatey.org/docs/how-to-recompile-packages) 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 `.nupkg`s 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)](https://github.com/TheCakeIsNaOH/choco-remixer/blob/master/ADDING_PACKAGES.md) for more information on how to add support for another package. PRs welcome, see [CONTRIBUTING.md](https://github.com/TheCakeIsNaOH/choco-remixer/blob/master/CONTRIBUTING.md) for more information
Otherwise, open an [issue](https://github.com/TheCakeIsNaOH/choco-remixer/issues/new) 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](https://chocolatey.org/pricing#faq-pricing) that has [automated internalization functionality](https://chocolatey.org/docs/features-automatically-recompile-packages), 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 (`.nupkg`s 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
