Windows App SDK Documentation

Windows App SDK Deployment Options

Deploying applications built with the Windows App SDK involves distributing the necessary runtime components along with your application package. The Windows App SDK supports several deployment models, each with its own advantages and considerations.

Understanding Deployment Dependencies

Applications built with the Windows App SDK rely on a set of runtime components. These components are typically packaged and versioned separately from the Windows operating system. This allows for independent updates and provides flexibility for developers.

MSIX Packaging

The recommended and most common deployment method for Windows App SDK applications is MSIX. MSIX is a modern packaging format that provides a reliable installation experience, automatic updates, and a clean uninstallation process.

• Benefits of MSIX:
• Full-featured and modern installer technology.
• Reliable update and rollback capabilities.
• Clean uninstallation, removing all application files.
• Improved security through application isolation.
• Support for broad deployment channels (Microsoft Store, Enterprise, etc.).

When deploying via MSIX, you can bundle the Windows App SDK runtime within your package or rely on the framework package being pre-installed on the user's machine.

Framework Packages

The Windows App SDK runtime is distributed as a set of framework packages. These packages contain the shared libraries and components that your application depends on. There are two primary ways to handle framework packages:

1. Self-contained Deployment:

   In a self-contained deployment, you package a specific version of the Windows App SDK runtime directly within your application's package. This ensures that your application runs with the intended runtime components, regardless of what is installed on the user's system. This is often the simplest approach for ensuring compatibility.

   Note: Self-contained deployments can result in larger application package sizes as the runtime is duplicated for each application.
2. Framework-dependent Deployment:

   In a framework-dependent deployment, your application's package declares a dependency on a specific version of the Windows App SDK framework package. The runtime components are installed separately on the user's machine. This approach is more efficient in terms of disk space as multiple applications can share the same installed runtime.

   Tip: For enterprise scenarios or when deploying multiple Windows App SDK applications, framework-dependent deployment can be more efficient.

Deployment Scenarios

The choice of deployment strategy depends on your target audience and distribution method:

• Microsoft Store: Applications submitted to the Microsoft Store are typically deployed using MSIX with framework-dependent packages. The Store handles the installation and management of the required framework packages.
• Enterprise Deployment: For internal line-of-business applications, you can use MSIX with either self-contained or framework-dependent deployment. Administrators can pre-deploy framework packages or ensure applications are self-contained.
• Direct Distribution: If you are distributing your application directly (e.g., through a website), MSIX packages (either self-contained or framework-dependent) are still the recommended approach.

Key Deployment Considerations

• Runtime Versioning: Ensure compatibility between your application's build and the deployed runtime version. Mismatches can lead to runtime errors.
• Package Dependencies: Clearly define the required Windows App SDK framework package versions in your application's manifest.
• Installer Technology: Leverage MSIX for a robust and modern deployment experience.
• Testing: Thoroughly test your deployment strategy on various target environments to ensure a smooth user experience.

For detailed guidance on creating MSIX packages and managing runtime dependencies, please refer to the specific documentation on MSIX packaging and framework package management.