Skip to content

(doc) Update Extension package docs #1078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2024
Merged

(doc) Update Extension package docs #1078

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/content/docs/en-us/guides/create/create-extension-package.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ As we've mentioned in other articles, a Chocolatey package can do near anything

In this how-to, we'll talk about sharing functions between packages using extension packages.

### Back To Basics Livestream

The creation, and usage, of Chocolatey extension packages was a topic of a recent [back-to-basics](https://blog.chocolatey.org/tags/back-to-basics) livestream.
The recording of that livestream can be found here:

<div class="ratio ratio-16x9 mb-3">
<iframe width="560" height="315" src="https://www.youtube.com/embed/ODCZ7yumJJc" frameborder="0" allowfullscreen></iframe>
</div>

### What Is an Extension Package

In Chocolatey-parlance, an extension package is a package that extends the ability of other Chocolatey packages, by making additional PowerShell functions or cmdlets available.
Expand Down Expand Up @@ -173,6 +182,21 @@ Get-ChildItem $env:ChocolateyInstall\extensions
Get-ChildItem $env:ChocolateyInstall\extensions\example
```

### Where Are Extensions Stored?

Chocolatey packages are stored within the `lib` folder, of the Chocolatey installation location.
This is the `C:\ProgramData\chocolatey\lib` folder by default.
However, Chocolatey CLI understands packages that end with `.extension` and some additional processing is completed.
The actual extension package contents will be extracted, and stored, in the `C:\ProgramData\chocolatey\extensions` directory.
The name of the folder will match the name you gave to the extension package.

For example, an extension package with the name `chocolatey-windowsupdate.extension`, will, by default, have the package contents extracted to `C:\ProgramData\chocolatey\extensions\chocolatey-windowsupdate`.

This special handling for packages ending with `.extension` also applies to packages that end with `.hook` and `.template`.
For `.hook` packages, by default, there is a folder at `C:\ProgramData\chocolatey\hooks`.
For `.template` packages, by default, there is a folder at `C:\ProgramData\chocolatey\templates`.


### Using Shared PowerShell Functions

Once you've created your extension package, using the functions contained within is as simple as ensuring the package is installed (for instance, by adding a dependency) and calling the functions within your Chocolatey scripts.
Expand Down