How to Pin Packages with Chocolatey (with examples)

Chocolatey is a popular package manager for Windows that simplifies the installation, upgrading, and configuration of software packages. One of its useful features is the ability to “pin” specific packages at certain versions. When a package is pinned, it will be excluded automatically from upgrades, ensuring that it remains at the specified version until the pin is removed. This feature is particularly helpful in environments where stability and consistency are critical, such as in production systems or development environments that require specific software versions.

Use case 1: Display a list of pinned packages and their versions

Code:

choco pin list

Motivation:

Knowing which packages are pinned and at which version can be critical for system administrators or developers who are managing multiple software packages. This helps ensure transparency and allows for better management of dependencies, especially when troubleshooting or planning upgrades.

Explanation:

In this command, choco is the Chocolatey command-line tool, pin indicates the feature being used, and list is the command used to display all currently pinned packages, along with the versions they’re pinned at. This command produces a concise and straightforward list of all pinned packages, helping users understand which versions are locked and why.

Example output:

Chocolatey v0.10.15
Pinned Packages:
1> git | 2.30.0
2> nodejs | 14.15.4
3> python | 3.8.5

Use case 2: Pin a package at its current version

Code:

choco pin add --name git

Motivation:

Pinning a package at its current version can be particularly useful when you want to ensure that a known stable version remains on the system while avoiding accidental upgrades that could introduce bugs or incompatibilities. This is a common practice in production environments or when using critical software where version changes might lead to unexpected results.

Explanation:

• choco pin add: This command initiates the pinning process for Chocolatey.
• --name git: The --name flag specifies the name of the package to be pinned. In this example, ‘git’ is the package that will be pinned at its current version.

Example output:

Chocolatey v0.10.15
Pinning is now set for: git

Use case 3: Pin a package at a specific version

Code:

choco pin add --name nodejs --version 14.15.4

Motivation:

Sometimes, specific software features or compatibility is only available or stable in particular versions. Pinning a package at a specific version allows users to lock that version in place, preventing upgrades that could disrupt dependencies or system functionality, particularly when older versions are required for compatibility reasons.

Explanation:

• choco pin add: Initiates the pinning action in Chocolatey.
• --name nodejs: The --name flag is used to specify which package should be pinned, in this example, ’nodejs’.
• --version 14.15.4: The --version flag specifies the exact version to which the package should be pinned.

Example output:

Chocolatey v0.10.15
Pinning is now set for: nodejs | 14.15.4

Use case 4: Remove a pin for a specific package

Code:

choco pin remove --name python

Motivation:

There may arise situations where it is beneficial to allow a package to upgrade to the latest version, such as when security vulnerabilities need to be addressed through updates. Removing a pin from a package re-enables it for upgrades, ensuring that the software stays updated with the latest patches and features.

Explanation:

• choco pin remove: This command starts the process for unpinning a package using Chocolatey.
• --name python: The --name option specifies the package from which the pin should be removed, in this case, ‘python’.

Example output:

Chocolatey v0.10.15
Pin removed for: python

Conclusion:

Using the choco pin command effectively allows users to finely manage software versions on their systems, providing the flexibility to maintain or update packages according to specific needs. By understanding and utilizing these commands, users can ensure system stability while also having the option for flexibility in software updates, aligning with the operational requirements of different environments.