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

Latest commit

 

History

History
66 lines (45 loc) · 3.05 KB

README.md

File metadata and controls

66 lines (45 loc) · 3.05 KB
Raw

chocolatey

Chocolatey is a popular package manager for Windows, similar to Homebrew. This repository generates and updates "NuGet" packages for Chocolately.

Package Lifecycle

It's very important to be aware of how packages are published for Chocolatey:

  1. You create a NuGet and submit it to the Chocolatey API
  2. A series of automated checks are carried out on the packages. If you look at the package page you will see the new version in the Version History but it don't be "Listed" and it's Status will not be "Approved"
  3. If all the checks pass it waits until a Moderator (yes, a human) approved the package (this can take hours to days)
  4. Once approved the package is now listed and accessble

To learn more please review the Chocolatey Package Review Process documentation.

Building Packages

The basic process is simple:

choco apikey --key ${CHOCO_API_KEY} --source https://push.chocolatey.org/
choco pack
choco push

To avoid using Windows, instead use a Docker container which runs Choco thanks to Mono. Here is a complete example of using it to pack and push:

$ docker run -v `pwd`:/packages -ti  chocolatey/choco bash
root@0ac102431698:~# cd /packages/cnquery

### Configure the APIKEY and Source
root@0ac102431698:/packages/cnquery# CHOCO_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
root@0ac102431698:/packages/cnquery# choco apikey --key ${CHOCO_API_KEY} --source https://push.chocolatey.org/
Chocolatey v1.3.0
Added ApiKey for https://push.chocolatey.org/


### Now Pack
root@0ac102431698:/packages/cnquery# choco pack
Chocolatey v1.3.0
Attempting to build package from 'cnquery.nuspec'.
Successfully created package '/packages/cnquery/cnquery.8.0.0.nupkg'


### Finally, Push
root@0ac102431698:/packages/cnquery# choco push
Chocolatey v1.3.0
Attempting to push cnquery.8.0.0.nupkg to https://push.chocolatey.org/
cnquery 8.0.0 was pushed successfully to https://push.chocolatey.org/

About the API-Key

Our packages are owned and published by the 'mondoo' user, with the email/login of '[email protected]'. The password is in BitWarden's 'Development' Collection entitled: "Chocolatey Mondoo User & API Key". You can find the API Key here: https://community.chocolatey.org/account

If you rotate the API key, be sure to update the CHOCOLATEY_API_KEY secret in this repo.

Learn more