ProGet Documentation

Packages in ProGet

  • Last Modified: 2020-03-30

Packages help you uniformly distribute your applications and components.

Think of a package like a uniform-sized shipping box with uniform, machine- and human-readable labels describing the package. Inside the box are the things you want to deliver, and the box may even include assembly, installation, delivery or other instructions on what to do with the contents.

Packages have become a unifying concept across a DevOps toolchain because they are built once and deployed consistently across environments. This means everyone can be certain that what goes to production, is exactly what was built and tested.

Package Formats: Universal and Third-party

There's not a whole lot to a package: it's just a zip file containing the files you actually want to distribute, as well as a manifest file that describes the package itself. The specific layout of the zip file and manifest is referred to as a package format. ProGet supports the universal package format, as well as a variety of third-party formats.

Universal Package Format

The Universal Package format is very simple, and can be used to package applications and components built with any technology: ASP.NET websites, NodeJS applications, Windows services, plug-ins for your applications, system configuration scripts, and so on. It's designed for both general-purpose use, and as a platform for creating a new proprietary package format. You can also extend a universal package's manifest file with additional metadata (and then search using that metadata).

Third-party Package Formats

Third-party package formats were each designed with a very specific use case in mind and, as such, are more complex. For example, the NuGet package format was designed specifically for open source .NET libraries used by developers, and must take into account multiple versions of the .NET framework and dependency trees with multi-platform targeting.

While you could certainly package .NET libraries in a universal package, they wouldn't be usable by Visual Studio's NuGet plugin, or any of the existing NuGet tooling. Although you could use the UPack tooling instead, because they aren't designed specifically for .NET libraries, they won't offer as rich of a user experience as the NuGet tooling.

Best practice: if there is a third-party package format designed for your specific use case, consider it instead of universal packages. But for most purposes, universal packages provide the best combination of simplicity, utility, and extensibility.

Creating and Publishing Packages

There are a lot of options for creating and publishing universal packages to ProGet, either from a developer's workstation, a build server, or anywhere else:

To learn how to create and package using a third-party package format, refer to the appropriate third-party feed documentation.

Package Identification and Verification

One of the most important aspects of a package is that it is uniquely identifiable using a name and version. This simple, human-readable identification is what makes packages so easy to distribute and consume.

For example, “HDars-API 1.0.4” is version 1.0.4 of HDars-API, which is newer than “HDars-API 1.0.2”, older than “HDars-API 1.3.0”, and different than “HDars-Web 1.0.4”. “HDars-API” by itself is fairly meaningless, because it could refer to any version of HDars-API.

Universal packages (as well as some third-party packages) use the SemVer specification to describe the version number.

Unlist a Package

In order to remove or deprecate a package or a specific version of a package you can use the Unlist feature by browsing to the local package and clicking Unlist. This will give you the option to Unlist the version of the package you are viewing or all versions of the package.

List a Package

If you have unlisted a package or version of a package from a feed for any reason and wish to include it again you can simply click the List button on any package that has been unlisted.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 979eb9fd on master