Shirubasoft.Aspire.ModularAppHosts 13.2.0

Shirubasoft.Aspire.ModularAppHosts

Define an Aspire resource graph once, expose it as a typed C# contract, and reuse it across AppHosts. A consumer references the producer-owned contract package; repository configuration supplies source and build context when the module is imported from another checkout.

Packages

The runtime packages target .NET 10, the source generator supports .NET SDK 10.0.100 or later, and the Aspire-facing packages require Aspire 13.4.6 or later. The project is licensed under the MIT License.

Quick start

Prerequisites are .NET SDK 10.0.100 or later, Aspire CLI 13.4.6 or later, and a running Docker or Podman runtime. Add the core package to an AppHost or shared contract project, install the template, and scaffold a module:

dotnet add package Shirubasoft.Aspire.ModularAppHosts
dotnet new install Shirubasoft.Aspire.ModularAppHosts.Templates
dotnet new aspire-module --name CatalogModule --moduleName catalog --namespace Catalog.Modules

The generated contract is immediately runnable and can be replaced with the module's real resource graph:

using Aspire.Hosting;

namespace Catalog.Modules;

[GenerateDistributedApplicationModule(Name, Version = "1", PackageId = "Catalog.Modules")]
public static partial class CatalogModule
{
    public const string Name = "catalog";
    public const string ApiResourceName = "catalog-api";

    public static void Define(IDistributedApplicationModuleBuilder module)
    {
        module.AddContainer(ApiResourceName, "nginx", "alpine")
            .Configure((_, container) => container
                .WithHttpEndpoint(targetPort: 80, name: "http"));
    }
}

Reference the contract project or package from each consumer. The source generator creates AddCatalogModule, ImportCatalogModule, and typed resource properties:

using Catalog.Modules;

var builder = DistributedApplication.CreateBuilder(args);

var catalog = builder.AddCatalogModule();

builder.AddContainer("storefront", "nginx", "alpine")
    .WithReference(catalog.Api.GetEndpoint("http"))
    .WaitFor(catalog.Api);

await builder.Build().RunAsync();

From the AppHost directory, run aspire run and open the dashboard URL. Use ImportCatalogModule() instead when repository configuration should supply the module's source tree.

Next steps

• Define and import modules, including repository initialization, configuration, resource aliases, required host tools, and local project/container switching.
• Build and publish module images.
• Test an AppHost and Docker Compose deployment with one suite.
• Hand images between repositories with the workflow tool.
• Run the samples.

For repository setup, validation, and releases, see Contributing.